Updating information about the panels in 0.9.0

Youness Alaoui 2019-04-04 20:04:07 -04:00
parent 0f03aa1305
commit 75258055f3

@ -5,34 +5,85 @@ The full-screen mode allows you to work in a distraction-free environment.
# Starting and leaving full-screen mode
To **start** full-screen mode, open a text item, and click on the icon with two-arrows in the bottom-right: ![image](https://user-images.githubusercontent.com/1192933/32591882-9b7d73ee-c521-11e7-8b69-4a4ae1a23984.png).
To **start** full-screen mode, open a text item, and either press the `F11` key or click on the icon with two-arrows in the bottom-right: ![image](https://user-images.githubusercontent.com/1192933/32591882-9b7d73ee-c521-11e7-8b69-4a4ae1a23984.png).
To **leave**, you can either click on the right exit button ![image](https://user-images.githubusercontent.com/1192933/32592535-6f9da322-c524-11e7-93fe-be0058f0b12e.png) on the top-panel (see below), or press the `Esc` key.
To **leave**, you can either click on the right exit button ![image](https://user-images.githubusercontent.com/1192933/32592535-6f9da322-c524-11e7-93fe-be0058f0b12e.png) on the top-panel (see below), or press the `Esc` or `F11` key.
![image](https://user-images.githubusercontent.com/1192933/32591758-048a1794-c521-11e7-8469-e3014099d4ab.png)
# Using
# Using the full-screen mode
If you **move your mouse to the sides of the screens**, you'll see some panels:
If you **move your mouse to the sides of the screen**, you'll see panels appear that provide additional functionality.
- **On the top**, from left to right: **toggle spell-check**, formatting (currently not working), **exit**.
Right clicking on one of the panels will open a contextual menu. For the *top*, *left* and *bottom* panels, the contextual menu will allow you to configure the behaviour of the panel as well as its contents. The *right* panel's contextual menu allows you to scroll through the text.
![image](https://user-images.githubusercontent.com/1192933/32591955-e2931554-c521-11e7-8018-2a60b7792b4f.png)
You can use the `Alt-Left` or `Alt-PageUp` hotkeys to navigate to the previous text and the `Alt-Right` or `Alt-PageDown` hotkeys to navigate to the next text.
- **On the right**, the **scroll bar**.
## Top panel
- **On the bottom:** a combobox to **change the current theme**, and **word count** (and progress if you set any goals for that text)
- *On the top panel*, from left to right, you will find the **Toggle Spell-check** button, **Navigation** arrows, **New Text** button, **Folder Path** and **Text Title**, and the **Exit Full-screen mode** button.
![image](https://user-images.githubusercontent.com/1192933/32592102-8a184768-c522-11e7-9708-ba3114cc934e.png)
![fullscreen-top-panel](https://user-images.githubusercontent.com/27990/55594802-04e8c380-570f-11e9-87a2-69194be1cce9.png)
- **On the left, in the middle of the screen:** a **screen locker**. <img align="right" src="https://user-images.githubusercontent.com/1192933/32592445-004e9d00-c524-11e7-9cd7-40ff3f084da6.png">
- The *Top panel* contextual menu consists of the following options :
![image](https://user-images.githubusercontent.com/27990/55595307-319dda80-5711-11e9-8e0b-dc83dc94ebfa.png)
- **Auto-hide**: When enabled, the panel will automatically hide when the mouse exits its area
- **Spellcheck**: Show/Hide the spellcheck button
- **Navigation**: Show/Hide the Previous/Next Text navigation arrows
- **New Text**: Show/Hide the New Text button which can be used to create a new text after the current one in the parent folder.
- **Title**: Show/Hide the text's Title in the center of the panel.
- **Title: Show Full Path**: When enabled, the title will also include the full path of all parent folders in which the text resides.
You can lock the full screen window until:
Note that clicking on the Title or on one of the folders in the path will pop up another contextual menu that lists all of the texts in the parent folder and allows you to quickly navigate to the text of your choice.
- You reach a certain *word count* target.
- A certain amount of *time* has passed.
![image](https://user-images.githubusercontent.com/27990/55595539-60688080-5712-11e9-8a93-575f09e8f73b.png)
While locked, the button and escape key won't let you leave.
If you select a folder, then the first available text in that folder will be displayed. If a folder is greyed out however, it means that it does not contain any text entries.
## Right Panel
- *On the right*, the panel only contains the **scroll bar**.
Right clicking on it brings up the standard and self-explanatory scrollbar contextual menu.
![image](https://user-images.githubusercontent.com/27990/55595729-4aa78b00-5713-11e9-88da-3c25a17d00b1.png)
## Bottom Panel
- *On the bottom panel,* a combobox to **change the current theme**, the text's **word count** and the **progress bar** (if you had set any goals for that text) and the **clock**.
![fullscreen-bottom-panel](https://user-images.githubusercontent.com/27990/55594865-4bd6b900-570f-11e9-862b-6c97a5c77b2f.png)
- The *bottom panel* contextual menu consists of the following options : ![image](https://user-images.githubusercontent.com/27990/55595875-e1744780-5713-11e9-99d5-3627fbe1b8a2.png)
- **Auto-hide**: When enabled, the panel will automatically hide when the mouse exits its area
- **Theme selector**: Show/Hide the theme selector combobox
- **Word count**: Show/Hide the text's word count
- **Progress**: Show/Hide the text's Progress bar
- **Progress**: Auto Show/Hide**: Enables/Disables the automatic showing or hiding of the progress bar if you navigate to a text which has/doesn't have a goal set.
- **Clock**: Show/Hide the clock
- **Clock: Show Seconds**: Show/Hide the seconds in the clock
## Lock panel
- *On the left, in the middle of the screen,* there is the **screen locker**.
![image](https://user-images.githubusercontent.com/1192933/32592445-004e9d00-c524-11e7-9cd7-40ff3f084da6.png)
- The *Left panel* contextual menu consists of the following options :
![image](https://user-images.githubusercontent.com/27990/55595976-70815f80-5714-11e9-995e-7b878164fd05.png)
- **Auto-hide**: When enabled, the panel will automatically hide when the mouse exits its area
You can lock the full screen window until:
- You reach a certain *word count* target (defaults to the remaining number of words to reach the goal, if set).
- A certain amount of *time* has passed.
While locked, the button and escape key won't let you leave.
Note: If you navigate to a different text while having a word count lock, the count target will change to match the number of words in the new text. This can increase or decrease the target, and might remove the lock if you navigate to a text that exceeds the target amount of words.
# Customizing theme