Skip to content

Commit 43d2806

Browse files
MilliOnTealeavesMilliOnTealeaves
committed
Finished help page and setup
1 parent 2e2b3ea commit 43d2806

File tree

3 files changed

+105
-82
lines changed

3 files changed

+105
-82
lines changed

‎Help/HelpPage.html‎

Lines changed: 104 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -9,87 +9,110 @@
99
<body>
1010
<h1 class="inline-title" id="title">μEncode</h1><hr />
1111
<div class="body-wrapper">
12-
<h1 class="inline-title"> Help Page</h1> <hr />
13-
<h1 data-heading="Basics">Basics</h1>
14-
<h2 data-heading="Encoding or decoding a message">Encoding or decoding a message</h2>
15-
<h3 data-heading="1. Enter your message:">1. Enter your message:</h3>
16-
<ul>
17-
<li>Type your message into the textbox under ‘<strong>Input</strong>’</li>
18-
<li>Click the ‘<strong>Paste</strong>’ button</li>
19-
<li>Open a file—works best with text files</li>
20-
</ul>
21-
<h3 data-heading="2. Select mode (encode/decode) based on your intended action">2. Select mode (encode/decode) based on your intended action</h3>
22-
<ul>
23-
<li>To encode a message, select ‘<strong>Encode</strong>’</li>
24-
<li>To decode a message, select ‘<strong>Decode</strong>’</li>
25-
</ul>
26-
<h3 data-heading="3. Choose a type of encoding">3. Choose a type of encoding</h3>
27-
<p><em>For more information, see ‘Encoding Types’ under ‘Detailed Information’</em></p>
28-
<h3 data-heading="4. Select any options you want enabled">4. Select any options you want enabled</h3>
29-
<p><em>For more information, see ‘Options’ under ‘Detailed Information’</em> </p>
30-
<h3 data-heading="5. Click ‘**Run**’ to encode/encrypt your message">5. Click ‘<strong>Run</strong>’ to encode/encrypt your message</h3>
31-
<ul>
32-
<li>If you used AES encryption, make sure to save the key and initialisation vector if you elected to generate a new pair.</li>
33-
<li>When done, you can copy the output to your clipboard via the ‘<strong>Copy</strong>’ button or by having ‘<strong>Copy result when done</strong>’ enabled in the Options panel, or save it to a file (not yet available)</li>
34-
<li>Encoding/decoding a new</li>
35-
</ul>
36-
<h3 data-heading="6. Save your output!">6. Save your output!</h3>
37-
<ul>
38-
<li>Whether you just want to copy it or save it to a file, make sure you get your output stashed!</li>
39-
</ul>
40-
<h1 data-heading="Detailed Information">Detailed Information</h1>
41-
<h2 data-heading="Encoding Types">Encoding Types</h2>
42-
<h3 data-heading="Morse Code">Morse Code</h3>
43-
<p>Usage information:</p>
44-
<ul>
45-
<li>A space marks the end of a character</li>
46-
<li>Forward slash (<code>/</code>) is used for space <em>(Note: A space is needed on each side of the slash)</em></li>
47-
<li>Accepts both uppercase and lowercase input, but does not preserve case (decoding will always result in lowercase text)</li>
48-
</ul>
49-
<p>
50-
Example:<br>
51-
<code>mu is a letter</code> encodes to <code>-- ..- / .. ... / .- / .-.. . - - . .-.</code>
52-
</p>
53-
<p>Currently supported characters:</p>
54-
<ul>
55-
<li>English Letters A-Z</li>
56-
<li>Numbers 0-9</li>
57-
<li>
58-
Additional characters:<br>
59-
<code>. , ? ' ! / ( ) &amp; : ; = + - _ " $ @</code>
60-
</li>
61-
</ul>
62-
<h3 data-heading="Random Shift">Random Shift</h3>
63-
<ul>
64-
<li>Translates message to morse code, with every character shifted ‘forward’ by a random number</li>
65-
<li>E.g., with a shift of 3, <code>a</code> becomes <code>d</code>, <code>p</code> becomes <code>s</code>, etc.</li>
66-
<li>Also applies to characters</li>
67-
<li>Proprietary character order makes this harder to decode by hand</li>
68-
</ul>
69-
<h3 data-heading="Repeated Random Shift">Repeated Random Shift</h3>
70-
<ul>
71-
<li>Iteratively uses <strong>Random Shift</strong> to encode a message</li>
72-
<li>Decoding difficulty to decode is similar to <strong>Random Shift</strong> but takes longer</li>
73-
</ul>
74-
<h3 data-heading="AES Encryption">AES Encryption</h3>
75-
<ul>
76-
<li>Uses the AES standard and is interoperable with other AES software</li>
77-
<li>Most secure option available in μEncode</li>
78-
<li>Uses—or generates—a key and initialisation vector to encode any text</li>
79-
<li>Symmetric encryption—key and IV needed on both sides of communication line</li>
80-
</ul>
81-
<p>Usage information:</p>
82-
<ul>
83-
<li>μEncode uses the key and IV currently entered in the textboxes that appear when AES is selected</li>
84-
<li>If the key or IV field are left blank, or either of the two is invalid, a new pair is generated</li>
85-
<li>Supports all UTF-8 characters</li>
86-
</ul>
87-
<h2 data-heading="Options">Options</h2>
88-
<h3 data-heading="‘Copy result when done’">‘Copy result when done’</h3>
89-
<p>Enabling ‘<strong>Copy result when done</strong>’ will copy the result of encoding/decoding to the clipboard after you click ‘<strong>Run</strong>’</p>
90-
<h3 data-heading="‘Switch mode when done’">‘Switch mode when done’</h3>
91-
<p>Enabling ‘<strong>Switch mode when done</strong>’ will make the mode switch from encoding to decoding, or vice versa, after input is processed.</p>
92-
<p>This is useful in situations where one needs to encode messages to send and decode received messages in short succession</p>
12+
<h1 data-heading="Basics">Basics</h1>
13+
<h2 data-heading="Encoding or decoding a message">Encoding or decoding a message</h2>
14+
<h3 data-heading="1. Enter your message:">1. Enter your message:</h3>
15+
<ul>
16+
<li>Type your message into the textbox under ‘<strong>Input</strong>’</li>
17+
<li>Click the ‘<strong>Paste</strong>’ button</li>
18+
<li>Open a file—works best with text files</li>
19+
</ul>
20+
<h3 data-heading="2. Select mode (encode/decode) based on your intended action">2. Select mode (encode/decode) based on your intended action</h3>
21+
<ul>
22+
<li>To encode a message, select ‘<strong>Encode</strong>’</li>
23+
<li>To decode a message, select ‘<strong>Decode</strong>’</li>
24+
</ul>
25+
<h3 data-heading="3. Choose a type of encoding">3. Choose a type of encoding</h3>
26+
<p><em>For more information, see ‘Encoding Types’ under ‘Detailed Information’</em></p>
27+
<h3 data-heading="4. Select any options you want enabled">4. Select any options you want enabled</h3>
28+
<p><em>For more information, see ‘Options’ under ‘Detailed Information’</em> </p>
29+
<h3 data-heading="5. Click ‘**Run**’ to encode/encrypt your message">5. Click ‘<strong>Run</strong>’ to encode/encrypt your message</h3>
30+
<ul>
31+
<li>If you used AES encryption, make sure to save the key and initialisation vector if you elected to generate a new pair.</li>
32+
<li>When done, you can copy the output to your clipboard via the ‘<strong>Copy</strong>’ button or by having ‘<strong>Copy result when done</strong>’ enabled in the Options panel, or save it to a file (not yet available)</li>
33+
<li>Encoding/decoding a new</li>
34+
</ul>
35+
<h3 data-heading="6. Save your output!">6. Save your output!</h3>
36+
<ul>
37+
<li>Whether you just want to copy it or save it to a file, make sure you get your output stashed!</li>
38+
</ul>
39+
<h1 data-heading="Detailed Information">Detailed Information</h1>
40+
<h2 data-heading="Encoding Types">Encoding Types</h2>
41+
<h3 data-heading="Morse Code">Morse Code</h3>
42+
<p>Usage information:</p>
43+
<ul>
44+
<li>A space marks the end of a character</li>
45+
<li>Forward slash (<code>/</code>) is used for space <em>(Note: A space is needed on each side of the slash)</em></li>
46+
<li>Accepts both uppercase and lowercase input, but does not preserve case (decoding will always result in lowercase text)</li>
47+
</ul>
48+
<p>
49+
Example:<br>
50+
<code>mu is a letter</code> encodes to <code>-- ..- / .. ... / .- / .-.. . - - . .-.</code>
51+
</p>
52+
<p>Currently supported characters:</p>
53+
<ul>
54+
<li>English Letters A-Z</li>
55+
<li>Numbers 0-9</li>
56+
<li>
57+
Additional characters:<br>
58+
<code>. , ? ' ! / ( ) &amp; : ; = + - _ " $ @</code>
59+
</li>
60+
</ul>
61+
<h3 data-heading="Random Shift">Random Shift</h3>
62+
<ul>
63+
<li>Translates message to morse code, with every character shifted ‘forward’ by a random number</li>
64+
<li>E.g., with a shift of 3, <code>a</code> becomes <code>d</code>, <code>p</code> becomes <code>s</code>, etc.</li>
65+
<li>Also applies to characters</li>
66+
<li>Proprietary character order makes this harder to decode by hand</li>
67+
</ul>
68+
<h3 data-heading="Repeated Random Shift">Repeated Random Shift</h3>
69+
<ul>
70+
<li>Iteratively uses <strong>Random Shift</strong> to encode a message</li>
71+
<li>Decoding difficulty to decode is similar to <strong>Random Shift</strong> but takes longer</li>
72+
</ul>
73+
<h3 data-heading="AES Encryption">AES Encryption</h3>
74+
<ul>
75+
<li>Uses the AES standard and is interoperable with other AES software</li>
76+
<li>Most secure option available in μEncode</li>
77+
<li>Uses—or generates—a key and initialisation vector to encode any text</li>
78+
<li>Symmetric encryption—key and IV needed on both sides of communication line</li>
79+
</ul>
80+
<p>Usage information:</p>
81+
<ul>
82+
<li>μEncode uses the key and IV currently entered in the textboxes that appear when AES is selected</li>
83+
<li>If the key or IV field are left blank, or either of the two is invalid, a new pair is generated</li>
84+
<li>Supports all UTF-8 characters</li>
85+
</ul>
86+
<h2 data-heading="Options">Options</h2>
87+
<h3 data-heading="‘Copy result when done’">‘Copy result when done’</h3>
88+
<p>Enabling ‘<strong>Copy result when done</strong>’ will copy the result of encoding/decoding to the clipboard after you click ‘<strong>Run</strong>’</p>
89+
<h3 data-heading="‘Switch mode when done’">‘Switch mode when done’</h3>
90+
<p>Enabling ‘<strong>Switch mode when done</strong>’ will make the mode switch from encoding to decoding, or vice versa, after input is processed.</p>
91+
<p>This is useful in situations where one needs to encode messages to send and decode received messages in short succession</p>
92+
<h1 data-heading="Keyboard Shortcuts">Keyboard Shortcuts</h1>
93+
<h2 data-heading="List of Shortcuts">List of Shortcuts</h2>
94+
<h3 data-heading="Input and Output">Input and Output</h3>
95+
<ul>
96+
<li><code>Ctrl+O</code>&nbsp;to open a file</li>
97+
<li><code>Ctrl+S</code>&nbsp;to save the output as a file</li>
98+
<li><code>Ctrl+Shift+V</code>&nbsp;to paste the input from your clipboard</li>
99+
<li><code>Ctrl+Shift+C</code>&nbsp;to copy the output</li>
100+
<li><code>Ctrl+I</code>&nbsp;to focus on the input field</li>
101+
<li><code>Ctrl+Tab</code>&nbsp;to clear both input and output</li>
102+
</ul>
103+
<h3 data-heading="Encoding and Decoding">Encoding and Decoding</h3>
104+
<ul>
105+
<li><code>Ctrl+R</code>&nbsp;or&nbsp;<code>Ctrl+Enter</code>&nbsp;to run the encoder</li>
106+
<li><code>Ctrl+M</code>&nbsp;to switch between encoding and decoding modes</li>
107+
<li><code>Ctrl+E</code>&nbsp;to select ‘Encode’</li>
108+
<li><code>Ctrl+D</code>&nbsp;to select ‘Decode’</li>
109+
<li><code>Ctrl+1, 2, 3, or 4</code>&nbsp;to select different encodings</li>
110+
</ul>
111+
<h3 data-heading="Other">Other</h3>
112+
<ul>
113+
<li><code>Ctrl+H</code>&nbsp;or&nbsp;<code>F1</code>&nbsp;to open the help page</li>
114+
</ul>
115+
93116
</div>
94117
</body>
95118
</html>

‎Installer/MuEncodeInstaller.iss‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ DefaultDirName={autopf}\{#MyAppName}
2222
DisableProgramGroupPage=yes
2323
; Uncomment the following line to run in non administrative install mode (install for current user only.)
2424
;PrivilegesRequired=lowest
25-
OutputBaseFilename=MuEncodeSetup_v2.1
25+
OutputBaseFilename=MuEncodeSetup_v{#myAppVersion}
2626
SetupIconFile="C:\Users\emila\OneDrive\Pictures\Saved Pictures\greenMu.ico"
2727
Compression=lzma
2828
SolidCompression=yes

‎Installer/Output/MuEncodeSetup_v2.2.exe‎

1.91 MB
Binary file not shown.

0 commit comments

Comments
 (0)