prehistoric-systems/Crypto-Notepad
1
0
Fork 0
mirror of https://github.com/Crypto-Notepad/Crypto-Notepad.git synced 2026-03-11 08:55:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Documentation (markdown)

Alexander 2020-01-13 13:40:05 +02:00
parent 6be30a8663
commit 690e0d616c
1 changed files with 58 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
Documentation.md

@ -33,19 +33,43 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
## Settings
### Application
### General
#### Application
| Parameter | Description |
| ------ | ------ |
| Minimize to tray | Hide app to system tray on window minimize |
| Auto check updates on startup | Enable/disable automatic check for updates at startup |
| Close to tray | Hide app to system tray on app closing |
| Single instance | Allow only a single instance of app to be running |
#### Integration
| Parameter | Description |
| ------ | ------ |
| Integrate with windows context menu | Add app shortcuts to Windows explorer’s context menu |
| Associate with *.cnp files | Associate app with the *.cnp files |
| Show in "Send to" menu | Add app shortcut in "Send to" context menu |
#### Auto lock
| Parameter | Description |
| ------ | ------ |
| Auto lock on minimize | Enable/disable auto-lock file on minimize |
| Auto check updates on startup | Enable/disable automatic check for updates at startup |
| Main menu | Main menu visibility |
| Menu icons | Main menu icons visibility |
| Minimize to tray | Hide app to system tray on window minimize |
| Close to tray | Hide app to system tray on app closing |
| Single instance | Allow only a single instance of app to be running |
| If the app is inactive | Enable/disable auto-lock file based on time |
### Toolbar
### Interface
#### Main menu
| Parameter | Description |
| ------ | ------ |
| Visible | Main menu visibility |
| Menu icons | Main menu icons visibility |
#### Toolbar
| Parameter | Description |
| ------ | ------ |
@ -55,7 +79,15 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Old icons | Enable old toolbar icons (before v1.4.0) |
| Close button | Show close toolbar button |
### Status Panel
#### Search Panel
| Parameter | Description |
| ------ | ------ |
| Background color | Search panel background color |
| Font color | Search panel font color |
| Border | Search panel border style |
#### Status Panel
| Parameter | Description |
| ------ | ------ |
@ -66,14 +98,9 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Lines | Lines label visibility |
| Modified | Modified label visibility |
| Size | Size label visibility |
| Readonly | Readonly label visibility |
| Word wrap | Word wrap label visibility |
### Search Panel
| Parameter | Description |
| ------ | ------ |
| Background color | Search panel background color |
| Font color | Search panel font color |
| Border | Search panel border style |
### Editor
@ -81,11 +108,12 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| ------ | ------ |
| Font color | Editor font color |
| Background color | Editor background color |
| Insert key | Enable/Disable **Ins** key functionality|
| Font style | Editor font style |
| Border | Editor left padding size |
| Padding-left | Size of the left padding |
| Open links with | Set the hotkey for open the links |
| Border | Editor left padding size |
| Font | Editor font style |
| Insert key | Enable/Disable **Ins** key functionality|
### Encryption
@ -95,13 +123,6 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Key size | Can be either 128/192/256 |
| Password iterations | How many times the algorithm is executed on the text <br>(May cause to slow app performance) |
### Integration
| Parameter | Description |
| ------ | ------ |
| Integrate with windows context menu | Add app shortcuts to Windows explorer’s context menu |
| Associate with *.cnp files | Associate app with the *.cnp files |
| Show in "Send to" menu | Add app shortcut in "Send to" context menu |
## Hotkeys
### Action with files ###
@ -113,6 +134,8 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Ctrl + S | Save opened file |
| Ctrl + Shift + S | Save opened file with location choosing |
| Alt+ Shift + S | Save & Close opened file, without closing the app |
| Ctrl + Shift + O | Open file lLocation |
| Ctrl + Shift + D | Delete current opened file |
### App hotkeys ###
| Shortcut | Description |
@ -125,6 +148,8 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Ctrl + F | Open search panel |
| Ctrl + T | Always on top |
| Ctrl + P | Password generator |
| Ctrl + U | Checking for app updates |
| Ctrl + Shift + A | Open about window |
### Editor hotkeys ###
| Shortcut | Description |
@ -137,6 +162,8 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Del | Delete selected text |
| Ctrl + A | Select all text |
| Ctrl + Del | Clear editor content |
| Ctrl + W | Word wrap |
| Ctrl + R | Read-only |
## FAQ
* `What encryption values I need to use?`
@ -156,8 +183,8 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
## Screenshots
![main window](https://i.imgur.com/nv4vblA.png)<br>
![settings window](https://i.imgur.com/CziMCZR.png)<br>
![change password window](https://i.imgur.com/u4Sd4Ui.png)
![enter password window](https://i.imgur.com/bS1Tev6.png)<br>
![password generator](https://i.imgur.com/iCncf3b.png)
![main window](https://i.imgur.com/LDCELW3.png)<br>
![settings window](https://i.imgur.com/3HGAQVL.png)<br>
![change password window](https://i.imgur.com/NUNB2wg.png)
![enter password window](https://i.imgur.com/vlPiiav.png)<br>
![password generator](https://i.imgur.com/9Rjtjm1.png)