Skip to content
Snippets Groups Projects
Commit 3da6b671 authored by Kien Le's avatar Kien Le
Browse files

Merge branch 'master' into cleanup-type_hint_controller_code

# Conflicts:
#	sohstationviewer/controller/util.py
#	sohstationviewer/view/plotting/time_power_squared_dialog.py
parents 31133ff9 dcf80c06
No related branches found
No related tags found
1 merge request!31Add type hint to controller code
Pipeline #2023 failed with stage
in 3 minutes and 30 seconds
Showing
with 250 additions and 0 deletions
# SOH Station Viewer Documentation
Welcome to the SOH Station Viewer documentation. Here you will find usage guides and other useful information in navigating and using this software.
On the left-hand side you will find a list of currently available help topics.
The home button can be used to return to this page at any time.
# Table of Contents
+ [Table of Contents](01%20_%20Table%20of%20Contents.help.md)
+ [Shortcuts](02%20_%20Shortcuts.help.md)
+ [How to Use Help](03%20_%20How%20to%20Use%20Help.help.md)
+ [Search SOH n LOG](04%20_%20Search%20SOH%20n%20LOG.help.md)
# Shortcuts
<br />
Below is a list of available keyboard shortcuts for commonly used operations and
forms.
<br />
| Shortcut | Combination |
| -------- | ----------- |
| Ctrl + I | Open Documentation Viewer |
| Ctrl + F | Open folder (Change data directory to another location) |
# How to Use Help
---------------------------
---------------------------
## How to open
Go to Menu - Help and click on "Documentation".
<br />
---------------------------
## User interface
<br />
### Search box
The box to enter search text is placed at the top of the dialog.
<br />
### Search Through All Documents button
The button to search through all documents for search text located on the right of Search box.
<br />
### Toolbar
+ <img alt="Navigate to Table of Contents" src="images/help/table_contents.png" width="30" /> **Navigate to Table of Contents**: Go to 'Table of Contents' page.
+ <img alt="Recreate Table of Contents" src="images/help/recreate_table_contents.png" width="30" /> **Recreate Table of Contents**: If links in 'Table of Contents' are broken, the page can be recreated by clicking this button.
+ <img alt="Search Previous" src="images/help/search_previous.png" width="30" /> **Search Previous**: Highlight the previous found text and the view roll to its position.
+ <img alt="Search Next" src="images/help/search_next.png" width="30" /> **Search Next**: Highlight the next found text and the view roll to its position.
+ <img alt="Search Next" src="images/help/search_all_doc.png" width="30" /> **Navigate to Search Through All Documents**: Go to 'Search Through All Documents' result page.
<br />
### Document list
Is the list of all help documents located on the left of Help Dialog.
<br />
### Document View
Occupies the largest section of Help Dialog located on the right to display the content of the current selected document.
<br />
---------------------------
## How to search in Help Dialog
<br />
### Search for a text on the current document
Type a searched text, the first text found will be highlighted in the Document View and the view scrolls to its location.
User can traverse back and forth the view to look for previous or next search text using **Search Previous** or **Search Next** button.
<br />
### Search for all documents that contain the searched text
Type a searched text, click the button 'Search Through All Documents'.
A list of all documents that contain the searched text will be created in document 'Search Through All Documents'.
The document will be brought to Document View.
Click on the link of a document in 'Search Through All Documents' will bring its to Document View.
User can go back to 'Search Through All Documents' document any time by clicking on the name on Document List.
<br />
# Search Messages
---------------------------
---------------------------
## How to open
Search Messages dialog will open by itself after a data set are done with reading and plotting.
If it is closed by any reason, user can open it by go to Menu - Forms, and click on "Search Messages"
<br />
---------------------------
## User interface
<br />
### Search box
The box to enter search text is placed at the top of the dialog.
<br />
### Toolbar
+ <img alt="To Selected" src="images/search_messages/to_selected.png" width="30" /> **To Selected**: The current table rolls back to the current selected line.
+ <img alt="Search Previous" src="images/search_messages/search_previous.png" width="30" /> **Search Previous**: The current table rolls to the previous line that contains the searched text.
+ <img alt="Search Next" src="images/search_messages/search_next.png" width="30" /> **Search Next**: The current table rolls to the next line that contains the searched text.
+ <img alt="Save" src="images/search_messages/save.png" width="30" /> **Save**: Save the content of the table to a text file.
<br />
### Tabs
+ **Search SOH Lines** tab: to list all lines that includes searched text with its channel
+ **Processing Logs** tab: to list all processing logs with its log type and color of each line depends on its log type.
+ Each of the following tab is for one of SOH LOG channels
<br />
### Info box
Is the box to display the info of the selected line.
<br />
---------------------------
## How to search
<br />
### Search for a text
Type a searched text, the searched text will be highlighted through the table and the current table scrolls to the first line that contains the searched text.
User can traverse back and forth the current tab to look for previous or next search text using **Search Previous** or **Search Next** button.
<br />
### Filter all lines with searched text
The first tab **Search SOH Lines** is for filtering all lines that contains the searched text.
<br />
### Interaction with RT130 SOH channel's data point
When user click on a clickable data point on a SOH channel of RT130, SOH tab will be focused and the line corresponding to the data point will be brought up to view.
<br />
\ No newline at end of file
Document Title?
===
# Testing markdown features supported by Qt
To show this file in help, change extension to ".help.md"
[Links to other documents?](01 _ Table of Contents.md)
1. Numbered List
1. Sublist
2. Another Entry
1. Another Sublist
* Bulleted list
* Sublist
* Another Sublist
# Section
## Subsection
### Sub-subsection
#### Subsections all the way down
*Emphasis*
**Bold**
***Bold-Emphasis***
~strikethrough?~
> This is a quote
```
printf("%s\n", codeFences.doTheyWork ? "Success!" : "Oof.");
```
```c
printf("%s\n", syntaxHighlighting.doesItWork ? "Success!" : "Oof.");
```
---
^ This is a horizontal line
v This is an image
![An Image?](images/image.jpg)
---
Another horizontal line
Is there a footnote? [^1]
[^1]: Maybe.
Definition Lists
: Do they work?
Task Lists?
- [ ] Yes
- [ ] No
- [x] Maybe
==Highlighting==? Nope.
Subscripts? x~0 Nope.
Superscripts? ax^2 + bx + c = 0. Also Nope.
Html?
x<sub>0</sub> Yup.
x<sup>2</sup> Yup.
Tables?
~Not supported.~
Just kidding, they totally are, and I just didn't do it right.
| Is this | a table? |
| ------- | ------------ |
| Perhaps | Perhaps not. |
documentation/images/help/home.png

19.1 KiB

documentation/images/help/recreate_table_contents.png

25.7 KiB

documentation/images/help/search_next.png

4.72 KiB

documentation/images/help/search_previous.png

4.9 KiB

documentation/images/help/search_results.png

36.8 KiB

documentation/images/help/table_contents.png

22.2 KiB

documentation/images/image.jpg

24.1 KiB

documentation/images/search_messages/save.png

2.49 KiB

documentation/images/search_messages/search_next.png

4.72 KiB

documentation/images/search_messages/search_previous.png

4.9 KiB

documentation/images/search_messages/to_selected.png

29.1 KiB

images/home.png

19.1 KiB

images/recreate_table_contents.png

25.7 KiB

images/search_results.png

36.9 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment