Skip to content

Commit

Permalink
man:1.2.0: Major restructuring of folders
Browse files Browse the repository at this point in the history
- Also start using embedpage for the root index page.
- Small list page updates

Signed-off-by: Aesara <[email protected]>
  • Loading branch information
AesaraB committed Aug 25, 2024
1 parent d6f94a5 commit 1576888
Show file tree
Hide file tree
Showing 59 changed files with 113 additions and 84 deletions.
62 changes: 5 additions & 57 deletions pages/docs/manuals/v1.2.0/_index.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,23 @@
+++
title = "v1.2.0 User Manual"
date = 2015-01-01T12:00:00Z
summary = "Learn how to use MyPaint v1.2.0"
showTOC = true
showTOC = false
hideSummary = true
hideList = true
[[cascade]]
sectionNavURL = "/docs/manuals/v1.2.0"
+++

Welcome to the MyPaint v1.2.0 User manual. Here you can learn the broad strokes of how MyPaint works.
Welcome to the MyPaint v1.2.0 User manual. Here you can learn the broad strokes of how MyPaint works.<!--more-->

# User Interface
When MyPaint is first opened, a single relatively sparse window will appear. At the centre, there's a plain off-white
background where you can draw (the **canvas**). At the top, there are toolbars and menus. At the bottom, there's a
status bar with some buttons and indicators clustered in the corners.

{{< img src="mypaint-window-new.jpg" caption="A fresh installation of MyPaint" >}}
<br>
{{< img src="mypaint-window-in-use.jpg" caption="MyPaint can be customised with dockable panels and palettes, all hideable while you work.">}}

<br>

{{< flex grow="true" >}}
{{< bigbutton title="Main Toolbar" subtitle="Painting tools and other commands" href="ui/main-toolbar" >}}
{{< bigbutton title="UI Toolbar" subtitle="Customise the user interface" href="ui/ui-toolbar" >}}
{{< bigbutton title="Footer Bar" subtitle="Application status and brush controls" href="ui/footer-bar" >}}
{{< bigbutton title="Dockable Panels" subtitle="Tailor your painting experience" href="./panels-popups" >}}
{{< bigbutton title="Fullscreen Mode" subtitle="Maximise drawing space" href="ui/fullscreen" >}}
{{< /flex >}}
{{< embedpage "ui" >}}

# Painting
When brush strokes are placed on the canvas, three elements determine the change made to the picture: The *painting
tool*, *brush*, and *paint mode*. These three elements can be combined arbitrarily to fit any desired art style.

1. **Painting Tool**: Determines the broad *geometry* of the stroke.
2. **Brush**: Determines the *design* of the stroke.
3. **Paint Mode**: Determines the *effect* of the stroke unto the canvas.


## Painting Tools
> *Menu → Edit → Current Tool*
Painting tools change how the user makes strokes by adding or removing contraints on stroke input.

{{< flex grow=true >}}
{{< bigbutton title="Freehand" subtitle="Unconstrained strokes" href="painting/freehand" >}}
{{< bigbutton title="Lines & Curves" subtitle="Singular constrained strokes" href="painting/lines-and-curves" >}}
{{< bigbutton title="Connected Lines" subtitle="Consecutive lines & curves" href="painting/connected-lines" >}}
{{< bigbutton title="Ellipses & Circles" subtitle="Constrained circular strokes" href="painting/ellipses-and-circles" >}}
{{< bigbutton title="Inking" subtitle="Modify a stroke before committing to it" href="painting/inking" >}}
{{< /flex >}}

## Brushes
[Read more]({{< relref "./painting/brushes" >}})

## Paint Modes
blend modes, eraser. [Read more]({{< relref "painting/paint-modes" >}})
{{< embedpage "painting" >}}

# Canvas Tools
Tools also exist to interact with the canvas in other ways.

{{< flex grow=true >}}
{{< bigbutton title="View Tools" subtitle="Modify the viewport" href="ui/main-toolbar#view-main" >}}
{{< bigbutton title="Reposition Layer" subtitle="Modify a layer's position" href="canvas-tools/reposition-layer" >}}
{{< bigbutton title="Flood Fill" subtitle="Fill an enclosed area with colour" href="canvas-tools/flood-fill" >}}
{{< bigbutton title="Colour Picker" subtitle="Pick a brush colour from the canvas" href="canvas-tools/colour-picker" >}}
{{< bigbutton title="Stroke/Layer Picker" subtitle="Pick a brush stroke from the canvas" href="canvas-tools/stroke-layer-picker" >}}
{{< bigbutton title="Symmetry" subtitle="Add lines of symmetry brush strokes" href="canvas-tools/symmetry" >}}
{{< bigbutton title="Edit Frame" subtitle="Set a working space in the canvas" href="canvas-tools/frame" >}}
{{< /flex >}}
{{< embedpage "canvas-tools" >}}

# Preferences
> *Edit → Edit Preferences*, or *Window → Edit Preferences*
Expand Down
18 changes: 15 additions & 3 deletions pages/docs/manuals/v1.2.0/canvas-tools/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
+++
title = "Tools"
summmary = "A list of MyPaint's tools"
weight = 20
title = "Canvas Tools"
weight = 30
hideList = true
+++

Tools also exist to interact with the canvas in other ways.<!--more-->

{{< flex grow=true >}}
{{< bigbutton title="View Tools" subtitle="Modify the viewport" href="../ui/main-toolbar#view-main" >}}
{{< bigbutton title="Reposition Layer" subtitle="Modify a layer's position" href="reposition-layer" >}}
{{< bigbutton title="Flood Fill" subtitle="Fill an enclosed area with colour" href="flood-fill" >}}
{{< bigbutton title="Colour Picker" subtitle="Pick a brush colour from the canvas" href="colour-picker" >}}
{{< bigbutton title="Stroke/Layer Picker" subtitle="Pick a brush stroke from the canvas" href="stroke-layer-picker" >}}
{{< bigbutton title="Symmetry" subtitle="Add lines of symmetry brush strokes" href="symmetry" >}}
{{< bigbutton title="Edit Frame" subtitle="Set a working space in the canvas" href="frame" >}}
{{< /flex >}}
29 changes: 29 additions & 0 deletions pages/docs/manuals/v1.2.0/painting/_index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
+++
title = "Painting"
weight = 20
hideList = true
+++

When brush strokes are placed on the canvas, three elements determine the change made to the picture: The *painting
tool*, *brush*, and *paint mode*. These three elements can be combined arbitrarily to fit any desired art style.

1. **Painting Tool**: Determines the broad *geometry* of the stroke.
2. **Brush**: Determines the *design* of the stroke.
3. **Paint Mode**: Determines the *effect* of the stroke unto the canvas.


## Painting Tools
> *Menu → Edit → Current Tool*
Painting tools change how the user makes strokes by adding or removing contraints on stroke input.

{{< flex grow=true >}}
{{< bigbutton title="Freehand" subtitle="Unconstrained strokes" href="freehand" >}}
{{< bigbutton title="Lines & Curves" subtitle="Singular constrained strokes" href="lines-and-curves" >}}
{{< bigbutton title="Connected Lines" subtitle="Consecutive lines & curves" href="connected-lines" >}}
{{< bigbutton title="Ellipses & Circles" subtitle="Constrained circular strokes" href="ellipses-and-circles" >}}
{{< bigbutton title="Inking" subtitle="Modify a stroke before committing to it" href="inking" >}}
{{< /flex >}}

## Brushes
[Read more]({{< relref "brushes" >}})

## Paint Modes
blend modes, eraser. [Read more]({{< relref "paint-modes" >}})
File renamed without changes.
8 changes: 0 additions & 8 deletions pages/docs/manuals/v1.2.0/panels-popups/_index.md

This file was deleted.

20 changes: 19 additions & 1 deletion pages/docs/manuals/v1.2.0/ui/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
+++
title = "User Interface"
weight = 10
hideList = true
+++

This page provides an overview of the layout and details in MyPaint's UI
When MyPaint is first opened, a single relatively sparse window will appear. At the centre, there's a plain off-white
background where you can draw (the **canvas**). At the top, there are toolbars and menus. At the bottom, there's a
status bar with some buttons and indicators clustered in the corners.<!--more-->

{{< img src="mypaint-window-new.jpg" caption="A fresh installation of MyPaint" >}}
<br>
{{< img src="mypaint-window-in-use.jpg" caption="MyPaint can be customised with dockable panels and palettes, all hideable while you work.">}}

<br>

{{< flex grow="true" >}}
{{< bigbutton title="Main Toolbar" subtitle="Painting tools and other commands" href="main-toolbar" >}}
{{< bigbutton title="UI Toolbar" subtitle="Customise the user interface" href="ui-toolbar" >}}
{{< bigbutton title="Footer Bar" subtitle="Application status and brush controls" href="footer-bar" >}}
{{< bigbutton title="Dockable Panels" subtitle="Tailor your painting experience" href="./panels" >}}
{{< bigbutton title="Popup Windows" subtitle="A quick way to change settings" href="popups" >}}
{{< bigbutton title="Fullscreen Mode" subtitle="Maximise drawing space" href="fullscreen" >}}
{{< /flex >}}
11 changes: 5 additions & 6 deletions pages/docs/manuals/v1.2.0/ui/footer-bar/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
+++
title = "Footer bar"
summary = "A description of the strip of UI features at the bottom of the main window"
weight = 30
+++

The **Footer Bar** is a strip comprising the bottom of the [main window]({{< relref "../#user-interface" >}}). It
The **Footer Bar** is a strip comprising the bottom of the [main window]({{< relref "index" >}}). It
consists of a status bar, and two clusters of controls for changing the brush and colour.

# Status bar
Expand All @@ -26,16 +25,16 @@ The colour controls are clustered on the left side of the footer bar.
- A rectangle consisting of two sides (swatches). The left swatch shows the current brush colour, the right swatch shows
the previous colour.
- Clicking the left swatch (current colour) opens the colour selector popup. [Read more]({{< relref
"../panels-popups/colour-selector" >}})
"popups/colour-selector" >}})
- Clicking the right swatch (previous colour) reverts the brush to the previous colour.

**Edit Colour Details** button
- Open the *Set Current Colour* popup window for inputting numeric colour values. [Read more]({{< relref "../colour/numeric-values" >}})
- Open the *Set Current Colour* popup window for inputting numeric colour values. [Read more]({{< relref "../painting/colour/numeric-values" >}})

**Add Colour to Palette** button
> *Colour → Add Colour to Palette*
- Adds the current brush colour to the palette. The palette will open in a sidebar panel if it isn't already open. [Read
more]({{< relref "../panels-popups/palette" >}})
more]({{< relref "panels/palette" >}})

# Brush controls
{{< img src="mypaint-footer-bar-brush.jpg" float="right" >}}
Expand All @@ -45,7 +44,7 @@ The brush controls are clustered on the right side of the footer bar.
**Current Brush** indicator and menu
> *Brush → Change Brush…*, or <kbd>B</kbd>
- A square containing the current brush icon.
- Clicking the icon opens the brush groups popup. [Read more]({{< relref "../panels-popups/brush-groups" >}})
- Clicking the icon opens the brush groups popup. [Read more]({{< relref "popups/brush-groups" >}})

**Pick Stroke and Layer** button
> Press <kbd>W</kbd>
Expand Down
1 change: 1 addition & 0 deletions pages/docs/manuals/v1.2.0/ui/fullscreen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
+++
title = "Fullscreen Mode"
weight = 60
+++

MyPaint's fullscreen mode maximises useable drawing space on the screen.
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/manuals/v1.2.0/ui/main-toolbar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight = 10
{{< /id >}}

The **Main Toolbar** contains MyPaint's painting tools, and other commands. It is located at the top of the
[main window]({{< relref "../#user-interface" >}}), underneath the menubar. It continues into the [UI toolbar]({{< relref
[main window]({{< relref "index" >}}), underneath the menubar. It continues into the [UI toolbar]({{< relref
"ui-toolbar" >}}).

Clicking on a blank area of the main toolbar with the right mouse button reveals a context menu used to show/hide
Expand Down
19 changes: 19 additions & 0 deletions pages/docs/manuals/v1.2.0/ui/panels/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
+++
title = "Dockable Panels"
weight = 40
hideList = true
+++

To-do:
- Describe what dockable panels are (with images)
- How users can add/remove them

{{< flex grow="true" >}}
{{< bigbutton title="Tool Options" subtitle="Lorem ipsum" href="tool-options" >}}
{{< bigbutton title="Brush Groups" subtitle="Lorem ipsum" href="layers" >}}
{{< bigbutton title="Palette" subtitle="Lorem ipsum" href="palette" >}}
{{< bigbutton title="Layers" subtitle="Lorem ipsum" href="layers" >}}
{{< bigbutton title="History" subtitle="Lorem ipsum" href="history" >}}
{{< bigbutton title="Preview" subtitle="Lorem ipsum" href="preview" >}}
{{< bigbutton title="Scratchpad" subtitle="Lorem ipsum" href="scratchpad" >}}
{{< /flex >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title = "Tool Options Panel"
+++

The tool option panel shows different options depending on the active tool. There are some tools without options. Other tools have very similar options.
The **Tool Options Panel** is used to view and change parameters for the current tool. Some tools do not have
parameters, others have very similar parameters.

## Painting Tools - Tool Options Panels
![Freehand Tool Options](https://cloud.githubusercontent.com/assets/6949092/21095114/548baef0-c05a-11e6-9549-e0713a5d91b8.PNG)![Lines and Curves Tool Options](https://cloud.githubusercontent.com/assets/6949092/21095119/5970259a-c05a-11e6-8279-0a6f37e31270.png)![Connected Lines Tool Options](https://cloud.githubusercontent.com/assets/6949092/21095122/5c4bf4d8-c05a-11e6-914d-8297f734573a.png)![Circle and Ellipses Tool Optios](https://cloud.githubusercontent.com/assets/6949092/21095133/670dc00e-c05a-11e6-917a-fb4b720850ad.png)
Expand Down
4 changes: 4 additions & 0 deletions pages/docs/manuals/v1.2.0/ui/popups/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
+++
title = "Popup Windows"
weight = 50
+++
6 changes: 6 additions & 0 deletions pages/docs/manuals/v1.2.0/ui/popups/brush-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Brush Group Popup"
tags = "Incomplete"
+++

TBD
14 changes: 7 additions & 7 deletions pages/docs/manuals/v1.2.0/ui/ui-toolbar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,34 @@ buttons to toggle parts of the user interface. The UI toolbar is not customisabl
**Colour Selectors Menu** (three circles)
> *Colour → \<various\>*, or *Window → Colour Adjusters*
- The entries in this menu open different kinds of colour selector dock-panels. Each dock-panel gives you a different
way of changing the painting colour. [Read more]({{< relref "../colour/selectors" >}})
way of changing the painting colour. [Read more]({{< relref "../painting/colour/selectors" >}})

**Brush Groups Menu** (three brushes)
> *Brush → Brush Groups* or *Window → Brush Groups*
- The entries in this menu open different brush group dock-panels. Each dock-panel allows you to change the brush you
paint with. [Read more]({{< relref "../panels-popups/brush-groups" >}})
paint with. [Read more]({{< relref "popups/brush-groups" >}})

**Tool Options Panel** (cog)
> *Edit → Show Tool Options Panel*
- This panel shows options for the current tool. [Read more]({{< relref "../panels-popups/tool-options" >}})
- This panel shows options for the current tool. [Read more]({{< relref "panels/tool-options" >}})
**Layers Panel** (stack of paper)
> *Layer → Show Layers Panel*, or <kbd>L</kbd>
- This panel shows the layers tree (layer stack) for your working document. [Read more]({{< relref "../panels-popups/layers" >}})
- This panel shows the layers tree (layer stack) for your working document. [Read more]({{< relref "panels/layers" >}})
**Scratchpad Panel** (clipboard)
> *Scratchpad → Show Scratchpad Panel*, or <kbd>Shift</kbd>+<kbd>S</kbd>
- This panel is a little area where you can work on thumbnail sketches, stash references, or make palettes. Scratchpads
can be saved and loaded independently of the main working doc. [Read more]({{< relref "../panels-popups/scratchpad" >}})
can be saved and loaded independently of the main working doc. [Read more]({{< relref "panels/scratchpad" >}})

**Preview Panel** (camera viewfinder)
> *View → Preview*, or <kbd>Shift</kbd>+<kbd>P</kbd>
- The preview panel shows an overview of the entire document, and a viewfinder showing where you're zoomed to. [Read
more]({{< relref "../panels-popups/preview" >}})
more]({{< relref "panels/preview" >}})

**History Panel** (clock)
> *Edit → Recent Brushes and Colours*
- The history panel shows a short timeline of recent brushes and colours. [Read more]({{< relref "../panels-popups/history" >}})
- The history panel shows a short timeline of recent brushes and colours. [Read more]({{< relref "panels/history" >}})
{{< id "fullscreen-toggle" >}}**Fullscreen Mode Toggle**{{< /id >}}
> *View → Fullscreen*, or <kbd>F11</kbd>
Expand Down

0 comments on commit 1576888

Please sign in to comment.