Skip to content

Commit ea72767

Browse files
author
Humdinger
committed
Update documentation
* document changes to the Layers window. * document changes to the Colors window. * document changes to the Settings window. * document changes to the menu items. * update all screenshots of the main window (no more palette) * polishing and typo correction
1 parent 14e48f0 commit ea72767

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+24
-21
lines changed

artwork/Eagle.artpaint

1.03 MB
Binary file not shown.

artwork/main_window.wb

-332 KB
Binary file not shown.
-763 Bytes

documentation/add-ons/images/blur.jpg

-739 Bytes
-679 Bytes
-656 Bytes
-785 Bytes
-710 Bytes
-730 Bytes
-676 Bytes
-625 Bytes
-645 Bytes
-731 Bytes
-694 Bytes
-687 Bytes
-681 Bytes
-811 Bytes
-659 Bytes
-656 Bytes

documentation/add-ons/images/oil.jpg

-651 Bytes
-684 Bytes
-706 Bytes
-735 Bytes
-653 Bytes
-743 Bytes
-658 Bytes

documentation/add-ons/images/wave.jpg

-774 Bytes

documentation/add-ons/images/wood.jpg

-609 Bytes

documentation/images/main_window.png

-41 Bytes

documentation/images/menus_layer.png

882 Bytes
-2.02 KB
-10 Bytes
-1.05 KB
3.76 KB
-8.73 KB
-516 Bytes

documentation/main_window.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,10 @@ <h2>The main window</h2>
4343
<li>Zoom level shows a slider when clicked to set an arbitrary magnification, or in/decrease by 25% when clicking the <span class="button">+</span> / <span class="button">-</span> buttons.</li>
4444

4545
<li>Two color panes show the fore- and background colors. You can switch them with a right-click and change their color with a left-click which opens the <a href="./other_windows.html#colors">Colors</a> window. </li>
46-
47-
<li>Color sets offer direct access to colors. A left-click sets the foreground, a right-click the background color. The little arrow widgets let you switch between several sets you can create in the Colors window.</li>
4846
</ul>
4947

5048
<div class="box-info">
51-
<p>A few tips on non-obvious features for the impatient reader:</p>
49+
<h3>A few tips on non-obvious features for the impatient reader:</h3>
5250
<ul>
5351
<li><p>Holding <span class="key">SHIFT</span> has some of the tools snap to certain settings, like 45° angles for the <a href="./tools/straight-line.html">Straight Line</a> tool, or keep a 1:1 aspect ratio for the <a href="./tools/rectangle.html">Rectangle</a> or <a href="./tools/ellipse.html">Ellipse</a> tools to create a square or circle.</p></li>
5452

documentation/menus.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h3>File</h3>
4343

4444
<tr><td style="vertical-align: top"><img src="./images/menus_edit.png" style="border:none;padding:15px;float:right" alt="Menu: Edit" /></td><td style="vertical-align: top">
4545
<h3>Edit</h3>
46-
<p><span class="menu">Undo/Redo</span> the last action (the number of reversable actions can be adjusted in the settings).</p>
46+
<p><span class="menu">Undo/Redo</span> the last action (the number of reversible actions can be adjusted in the settings).</p>
4747

4848
<p>You can <span class="menu">Cut</span> or <span class="menu">Copy</span> the selection of the <span class="menu">Active layer</span> or <span class="menu">All layers</span> from their submenus.</p>
4949

@@ -56,9 +56,9 @@ <h3>Edit</h3>
5656
<h3>Layer</h3>
5757
<p>You can <span class="menu">Rotate…</span> and <span class="menu">Translate…</span> the current layer/selection. It'll pop up a window to enter the angle or x/y coordinates manually, or you can just rotate/move it all directly on the canvas. A right-click sets the rotation point.</p>
5858

59-
<p>You can also <span class="menu">Flip horizontally/vertically</span>, <span class="menu">Change transparency…</span> or <span class="menu">Clear</span> the current layer.</p>
59+
<p>You can <span class="menu">Flip horizontally/vertically</span> or <span class="menu">Clear</span> the current layer.</p>
6060

61-
<p><span class="menu">Add layer</span> creates a new layer in front of the current one. More options are available from the <a href="other_windows.html#layers">Layers</a> window.</p>
61+
<p><span class="menu">Add</span> creates a new layer and you can also <span class="menu">Delete</span>, <span class="menu">Duplicate</span> or <span class="menu">Merge down</span> (i.e. merge with one below) the currently selected layer.</p>
6262
</td></tr>
6363

6464
<tr><td style="vertical-align: top"><img src="./images/menus_canvas.png" style="border:none;padding:15px;float:right" alt="Menu: Canvas" /></td><td style="vertical-align: top">
@@ -76,7 +76,7 @@ <h3>Window</h3>
7676

7777
<p><span class="menu">Resize to fit</span> changes the main window size to best fit the canvas.</p>
7878

79-
<p>Last is a list of all the special panels described in this manual a bit later. It's a good idea to memorize the shortcuts to them.</p>
79+
<p>Last is a list of the special panels which are described under <a href="other_windows.html">The other windows</a>. It's a good idea to memorize the shortcuts to them.</p>
8080
</td></tr>
8181

8282
<tr><td style="vertical-align: top"><img src="./images/menus_add-ons.png" style="border:none;padding:15px;float:right" alt="Menu: Add-ons" /></td><td style="vertical-align: top">

documentation/other_windows.html

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,30 +30,36 @@ <h2>The other windows</h2>
3030
<p><span class="key">ALT</span>&#160;<span class="key">TAB</span> will hide/show all these windows for an unobscured view of the canvas.</p>
3131

3232
<table>
33-
<tr><td style="vertical-align: top"><img src="./images/windows_colors.png" style="border:none;padding:15px;float:right" alt="Window: Colors" /></td><td style="vertical-align: top">
33+
<tr><td colspan="2" style="vertical-align: top"><img src="./images/windows_colors.png" style="border:none;padding:0px;float:left" alt="Window: Colors" /></td></tr>
34+
<tr><td></td>
35+
<td style="vertical-align: top">
3436
<h3><a id="colors" name="colors">Colors</a></h3>
35-
<p>You can choose a different <span class="menu">Color model</span> from the menu: <span class="menu">RGB</span>, <span class="menu">CMY</span>, <span class="menu">HSV</span>, <span class="menu">YIQ</span>, <span class="menu">YUV</span> or <span class="menu">BeOS</span>. The additional "A" slider is the alpha channel, aka transparency.</p>
36-
<p>If you hold <span class="key">CTRL</span> while moving one slider, the others follow it, keeping their relative distance. Holding <span class="key">SHIFT</span> when clicking a slider sets the other sliders to that same value.</p>
37+
<p>You can choose a different <span class="menu">Color model</span> from the menu: <span class="menu">RGB</span>, <span class="menu">CMYK</span>, <span class="menu">HSV</span>, <span class="menu">CIELAB</span> or <span class="menu">BeOS</span>. The additional "A" slider is the alpha channel, aka transparency.</p>
38+
<p>When in RGB mode, holding <span class="key">SHIFT</span> when clicking a slider sets the other sliders to that same value. It's a quick way to set a shade of gray.</p>
39+
40+
<p>Selecting a color with the left mouse button sets the foreground color, the right sets the background color. The same happens when you move a slider with the left/right mouse button.</p>
41+
42+
<p>Below the pane on the right, the color is shown as a hex-value that you can copy and paste when editing an HTML document, for example. The other way around is also possible, paste a hex-value from your HTML document to use the color in ArtPaint.</p>
3743

3844
<p>Under <span class="menu">Color set</span> you can create a <span class="menu">New color set</span> with 8 to 64 colors, <span class="menu">Delete current set</span> and <span class="menu">Open/save color set</span>.</p>
3945

40-
<p>The little arrow widgets below the palette (also below the canvas in the main window) let you switch between the available color sets.</p>
46+
<p>The little arrow widgets beside the palette let you switch between the available color sets.</p>
4147
</td></tr>
4248

4349
<tr><td style="vertical-align: top"><img src="./images/windows_layers.png" style="border:none;padding:15px;float:right" alt="Window: Layers" /></td><td style="vertical-align: top">
4450
<h3><a id="layers" name="layers">Layers</a></h3>
45-
<p>Here you see all layers stacked up on each other, with the combination of them all and the project name at the top.</p>
51+
<p>Here you see all layers stacked up on each other, with a checkbox that controls if a layer is visible.</p>
4652

47-
<p>The checkbox controls if a layer is <span class="menu">Visible</span>.</p>
53+
<p>The <span class="menu">Layer</span> menu has commands to <span class="menu">Add</span> a new layer and to <span class="menu">Delete</span>, <span class="menu">Duplicate</span> or <span class="menu">Merge down</span> (i.e. merge with one below) the currently selected layer.</p>
4854

49-
<p>The pop-up menus have commands to <span class="menu">Merge with front/back layer</span>, <span class="menu">Add layer in front/behind</span>, <span class="menu">Duplicate layer</span> and <span class="menu">Delete layer</span>.</p>
55+
<p>You can arrange layers by dragging them around and rename them by editing their text field.</p>
5056

51-
<p>You can arrange layers by dragging them around.</p>
57+
<p>At the top is a slider to set a layer's transparency (<span class="menu">Alpha</span>) and a menu to set a blending <span class="menu">Mode</span>. Since ArtPaint implements these modes similarly to other graphics applications, you can find in-depth explanations for them online, e.g. in the <a href="https://helpx.adobe.com/photoshop/using/blending-modes.html">Photoshop help</a> or the <a href="https://docs.gimp.org/en/gimp-concepts-layer-modes.html">GIMP docs</a>.</p>
5258
</td></tr>
5359

5460
<tr><td style="vertical-align: top"><img src="./images/windows_tools+setup.png" style="border:none;padding:15px;float:right" alt="Window: Tools &amp; Tool setup" /></td><td style="vertical-align: top">
5561
<h3><a id="tools" name="tools">Tools &amp; Tool setup</a></h3>
56-
<p>Here you find all the available tools. By changing the window size, you can re-arrange their icons.</p>
62+
<p>Here you find all the available tools. By changing the Tools window size, you can re-arrange the icons.</p>
5763

5864
<p>A right-click opens the tool's setup window.</p>
5965

@@ -66,6 +72,8 @@ <h3><a id="brushes" name="brushes">Brushes</a></h3>
6672

6773
<p>Once you have configured a few different brushes - round, rectangular, big, small, soft, hard - you can quickly switch between them in the Brushes window.</p>
6874

75+
<p>The red line under the brush represents its scale: full-length means the representation is 1:1, half-length is 1:2 and so forth.</p>
76+
6977
<p>To remove a stored brush you can choose to <span class="menu">Delete selected brush</span> from the <span class="menu">Brush</span> menu.</p>
7078
</td></tr>
7179

documentation/settings.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h3>Windows</h3>
3535

3636
<tr><td style="vertical-align: top"><img src="./images/settings_undo.png" style="border:none;padding:15px;float:right" alt="Settings: Undo" /></td><td style="vertical-align: top">
3737
<h3>Undo</h3>
38-
<p>Depending on the amount of memory available and size and number of projects and layers you work with, you can set the number of revertable actions to <span class="menu">Off</span>, <span class="menu">Unlimited</span>, or choose <span class="menu">Adjustable</span> and set the number of <span class="menu">Undo steps</span> explicitely.</p></td></tr>
38+
<p>Depending on the amount of memory available and size and number of projects and layers you work with, you can set the number of revertable actions to <span class="menu">Off</span>, <span class="menu">Unlimited</span>, or choose <span class="menu">Adjustable</span> and set the number of <span class="menu">Undo steps</span> explicitly.</p></td></tr>
3939

4040
<tr><td style="vertical-align: top"><img src="./images/settings_transparency.png" style="border:none;padding:15px;float:right" alt="Settings: Transparency" /></td><td style="vertical-align: top">
4141
<h3>Transparency</h3>
@@ -45,9 +45,6 @@ <h3>Transparency</h3>
4545
<tr><td style="vertical-align: top"><img src="./images/settings_misc.png" style="border:none;padding:15px;float:right" alt="Settings: Miscellaneous" /></td><td style="vertical-align: top">
4646
<h3>Miscellaneous</h3>
4747
<p>You can set the mouse pointer to <span class="menu">Tool cursor</span> and have a small icon of the active tool beside it, or, to avoid obscuring even a few pixels, set to <span class="menu">Cross-hair cursor</span>.</p>
48-
49-
<p>Under <span class="menu">Application</span> you can disable <span class="menu">Confirm quitting</span> and you won't be warned if you have unsaved changes.</p>
50-
5148
</td></tr>
5249
</table>
5350
<hr />

documentation/tools/selection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ <h2>The Selection tool</h2>
4242

4343
<li><p><span class="menu">Intelligent scissors</span> tries to select along detected edges.</p></li>
4444

45-
<li><p><span class="menu">Magic wand</span> chooses all pixels of a similar color. You set the <span class="menu">Tolerance</span> for what's considerd 'similar' with the slider below.</p></li>
45+
<li><p><span class="menu">Magic wand</span> chooses all pixels of a similar color. You set the <span class="menu">Tolerance</span> for what's considered 'similar' with the slider below.</p></li>
4646
</ul>
4747

4848
</td></tr>

0 commit comments

Comments
 (0)