Moved the back to previous page buttons above page titles

stipple-effect · Jan 11, 2025 · 3f603e8 · 3f603e8
1 parent 2f96d3d
commit 3f603e8
Show file tree

Hide file tree

Showing 42 changed files with 80 additions and 80 deletions.
diff --git a/automation-scripts.md b/automation-scripts.md
@@ -2,10 +2,10 @@
 title: Automation scripts | Stipple Effect documentation
 ---
 
-# Automation scripts
-
 [`< Scripting`](./scripting.md)
 
+# Automation scripts
+
 As the name suggests, **automation scripts** are designed for the automation of tasks that would be repetitive and tedious to complete manually. However, their scope extends far beyond that, as they can be used to programmatically execute most program actions.
 
 ## Contract

diff --git a/brush.md b/brush.md
@@ -1,7 +1,7 @@
-# Brush
-
 [`< Tools`](./tools.md)
 
+# Brush
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/brush.png)
 
 **Hotkey:** <kbd>B</kbd>

diff --git a/cel.md b/cel.md
@@ -2,10 +2,10 @@
 title: Cel | Stipple Effect documentation
 ---
 
-# Cel
-
 [`< Projects`](./project.md)
 
+# Cel
+
 A **cel** is an intersection of a [layer](./layer.md) and a [frame](./frame.md). A cel comprises the contents of a layer at a particular frame index.
 
 A [project](./project.md) with 6 layers and 12 frames consists of 72 (6 x 12) cels. Thus, a project can be thought of as a matrix of cels.

diff --git a/child-scripts.md b/child-scripts.md
@@ -1,7 +1,7 @@
-# Child scripts
-
 [`< Scripting`](./scripting.md)
 
+# Child scripts
+
 **Child script** is a catch-all categorization for a script that is executed from within another script. A script that calls a child script is known as the **parent script**. Like "child script", this is also a relative, contextually-dependent categorization.
 
 Child scripts are useful for housing atomic chunks of work that would otherwise have to be written over and over as part of longer automation, preview, and color scripts.

diff --git a/color-actions.md b/color-actions.md
@@ -1,7 +1,7 @@
-# Color actions
-
 [`< Overview`](./README.md)
 
+# Color actions
+
 **Color actions** are algorithmic operations that operate over every pixel in a given [scope](./scope.md) of the current [project](./project.md).
 
 ## ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/palettize.png) Palettization

diff --git a/color-picker.md b/color-picker.md
@@ -1,7 +1,7 @@
-# Color Picker
-
 [`< Tools`](./tools.md)
 
+# Color Picker
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/color_picker.png)
 
 **Hotkey:** <kbd>C</kbd>

diff --git a/color-scripts.md b/color-scripts.md
@@ -1,7 +1,7 @@
-# Color scripts
-
 [`< Scripting`](./scripting.md)
 
+# Color scripts
+
 **Color scripts** are used to define the behaviour of the [script brush](./script-brush.md) ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/script_brush.png) tool and the ["run a color script"](./color-actions.md#run-a-color-script) ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/color_script.png) color action. They describe a **color to color transformation**.
 
 **Note:**

diff --git a/color.md b/color.md
@@ -1,7 +1,7 @@
-# Color
-
 [`< Overview`](./README.md)
 
+# Color
+
 This article is meant to (1) provide an overview of the digital color theory concepts that one should understand in order to best use *Stipple Effect*, and (2) explain and illustrate some of *Stipple Effect*'s color-related jargon and conventions.
 
 ## Color models

diff --git a/eraser.md b/eraser.md
@@ -1,7 +1,7 @@
-# Eraser
-
 [`< Tools`](./tools.md)
 
+# Eraser
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/eraser.png)
 
 **Hotkey:** <kbd>E</kbd>

diff --git a/extract-to-pal.md b/extract-to-pal.md
diff --git a/fill-tool.md b/fill-tool.md
@@ -1,7 +1,7 @@
-# Fill
-
 [`< Tools`](./tools.md)
 
+# Fill
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/fill.png)
 
 **Hotkey:** <kbd>F</kbd>

diff --git a/fonts.md b/fonts.md
@@ -1,7 +1,7 @@
-# Fonts
-
 [`< Overview`](./README.md)
 
+# Fonts
+
 *Stipple Effect* uses the underlying [*Delta Time*![](./assets/ui/external.png)](https://github.com/jbunke/delta-time) library to load and display fonts. Thus, the program's native system fonts, as well as user-defined fonts uploaded for use by the [text tool](./text-tool.md) at runtime, must comply with Delta Time's **font standard**.
 
 ## Font files

diff --git a/frame.md b/frame.md
@@ -2,10 +2,10 @@
 title: Frame | Stipple Effect documentation
 ---
 
-# Frame
-
 [`< Projects`](./project.md)
 
+# Frame
+
 A **frame** is a snapshot of an animation. Multi-frame [projects](./project.md) are considered **animations**, while a project with a single frame is **static**.
 
 Frames are *Stipple Effect* projects' horizontal organizational axis. Conversely, [layers](./layer.md) make up the vertical axis. The intersection of a particular frame and a particular layer is called a [cel](./cel.md).

diff --git a/gradient-tool.md b/gradient-tool.md
@@ -1,7 +1,7 @@
-# Gradient Tool
-
 [`< Tools`](./tools.md)
 
+# Gradient Tool
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/gradient_tool.png)
 
 **Hotkey:** <kbd>G</kbd>

diff --git a/hand.md b/hand.md
@@ -1,7 +1,7 @@
-# Hand
-
 [`< Tools`](./tools.md)
 
+# Hand
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/hand.png)
 
 **Hotkey:** <kbd>H</kbd>

diff --git a/hsv-shift.md b/hsv-shift.md
diff --git a/interface.md b/interface.md
@@ -2,10 +2,10 @@
 title: The Interface | Stipple Effect documentation
 ---
 
-# The Interface
-
 [`< Overview`](README.md)
 
+# The Interface
+
 ![](./assets/interface/panel-config.gif)
 
 The program interface consists of a viewport called the "workspace" surrounded by a series of panels. Any of these panels can be hidden according to the preferences of the user or the demands of the task at hand.

diff --git a/layer.md b/layer.md
@@ -2,10 +2,10 @@
 title: Layer | Stipple Effect documentation
 ---
 
-# Layer
-
 [`< Projects`](./project.md)
 
+# Layer
+
 **Layers** are stacked on top of one another and rendered in order to compose the [project](./project.md).
 
 Layers are *Stipple Effect* projects' vertical organizational axis. Conversely, [frames](./frame.md) make up the horizontal axis. The intersection of a particular layer and a particular frame is called a [cel](./cel.md).

diff --git a/line-tool.md b/line-tool.md
@@ -1,7 +1,7 @@
-# Line Tool
-
 [`< Tools`](./tools.md)
 
+# Line Tool
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/line_tool.png)
 
 **Hotkey:** <kbd>L</kbd>

diff --git a/outline.md b/outline.md
@@ -1,7 +1,7 @@
-# Outlining
-
 [`< Overview`](./README.md)
 
+# Outlining
+
 **Outlining** in *Stipple Effect* works differently than it does in most similar art programs. Rather than filling the outline of a layer or a selection, the various outline actions in *Stipple Effect* simply propagate the [pixel selection](./selection.md) to its own outline based on a certain **outline configuration**, also called a **side mask**.
 
 ## ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/outline.png) Outline configuration menu

diff --git a/palette.md b/palette.md
@@ -1,7 +1,7 @@
-# Color palettes
-
 [`< Overview`](./README.md)
 
+# Color palettes
+
 A core component of pixel art is a restricted **color palette**.
 
 In modern digital art, a [24-bit RGB color space](./color.md#rgba) allows us to represent over 16 million unique colors. However, pixel art is a medium of constraints. One of the constraints of traditional pixel art is a highly restrictive color palette comprised from as little as two to a few dozen colors.

diff --git a/pencil.md b/pencil.md
@@ -1,7 +1,7 @@
-# Pencil
-
 [`< Tools`](./tools.md)
 
+# Pencil
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/pencil.png)
 
 **Hotkey:** <kbd>P</kbd>

diff --git a/pixel-grid.md b/pixel-grid.md
@@ -1,7 +1,7 @@
-# Pixel grid and checkerboard
-
 [`< Overview`](./README.md)
 
+# Pixel grid and checkerboard
+
 The **pixel grid** and **checkerboard** are visual aides that are central to many workflows in *Stipple Effect*.
 
 Pixel grid lines can vary in length per dimension from 1 pixel to 128 pixels, while checkerboard squares/rectangles can range from 1 pixel to 256 pixels high and wide.

diff --git a/preview-scripts.md b/preview-scripts.md
@@ -1,7 +1,7 @@
-# Preview scripts
-
 [`< Scripting`](./scripting.md)
 
+# Preview scripts
+
 *Stipple Effect* has a [preview window](./preview-window.md) to give the user a secondary viewport with which to view the [project](./project.md) alongside the [workspace](./interface.md#workspace). By default, the preview window merely displays the project as it is. However, with **preview scripts**, the user can define an algorithm that transforms the project's contents for the sake of display in the preview window.
 
 The script is executed every time that the user edits the project. An edit to the project might be a brush stroke or an [undo](./state-control.md#undo) operation or a paste action. However, advancing the frame index, for example, is not considered an edit.

diff --git a/preview-window.md b/preview-window.md
@@ -1,7 +1,7 @@
-# Preview window
-
 [`< The interface`](./interface.md)
 
+# Preview window
+
 The **preview window** is a secondary viewport that complements the [workspace](./interface.md#workspace). It can be used to view the [project](./project.md) at a different zoom level or to loop an animation while editing a particular [frame](./frame.md) in the workspace.
 
 It can be opened ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/preview.png) with <kbd>Shift</kbd> + <kbd>Space</kbd> or with `View > Show preview`.

diff --git a/project.md b/project.md
@@ -2,10 +2,10 @@
 title: Project | Stipple Effect documentation
 ---
 
-# Project
-
 [`< Overview`](./README.md)
 
+# Project
+
 A *Stipple Effect* session consists of one or multiple **projects**. Projects are sometimes referred to – especially in the [source code![](./assets/ui/external.png)](https://github.com/stipple-effect/stipple-effect) – as **contexts**.
 
 The projects that are currently loaded in the program are arranged in the [projects panel](./interface.md#projects).

diff --git a/save.md b/save.md
@@ -1,7 +1,7 @@
-# Saving & Exporting
-
 [`< Overview`](./README.md)
 
+# Saving & Exporting
+
 In addition to saving [projects](./project.md) to *Stipple Effect*'s native file type, users have several export options depending on whether a project is [static or an animation](./frame.md), and for which purposes they intend to use or distribute an asset.
 
 ## Native file type

diff --git a/scope.md b/scope.md
@@ -1,7 +1,7 @@
-# Scope
-
 [`< Overview`](./README.md)
 
+# Scope
+
 Algorithmic operations such as [color actions](./color-actions.md) are executed over a user-determined **scope**. This page lists and briefly describes the possible scopes for such operations, as well as the related **options**.
 
 ### Scopes

diff --git a/script-brush.md b/script-brush.md
@@ -1,7 +1,7 @@
-# Script Brush
-
 [`< Tools`](./tools.md)
 
+# Script Brush
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/script_brush.png)
 
 **Hotkey:** <kbd>Q</kbd>

diff --git a/scripting.md b/scripting.md
@@ -1,7 +1,7 @@
-# Scripting
-
 [`< Overview`](./README.md)
 
+# Scripting
+
 *Stipple Effect* lets users write scripts for a wide range of potential uses and applications. A **script** is a short series of instructions for the program to execute.
 
 ## DeltaScript

diff --git a/sel-area-tools.md b/sel-area-tools.md
@@ -1,7 +1,7 @@
-# Selection area tools
-
 [`< Tools`](./tools.md)
 
+# Selection area tools
+
 ## Universal
 
 Selection area tools have **simple**, **additive**, and **subtractive** selection modes:

diff --git a/sel-move-tools.md b/sel-move-tools.md
@@ -1,7 +1,7 @@
-# Selection movement tools
-
 [`< Tools`](./tools.md)
 
+# Selection movement tools
+
 ## Universal
 
 The **move selection** and **pick up selection** behave almost identically. The only difference is that the move selection tool modifies the *selection area*, while the pick up selection tool modifies the *contents of the selection*.

diff --git a/selection.md b/selection.md
@@ -1,7 +1,7 @@
-# Selection
-
 [`< Overview`](./README.md)
 
+# Selection
+
 At any given point, a set of pixels on a [project](./project.md)'s canvas may be selected.
 
 Selections can me determined by [selection area tools](./sel-area-tools.md) and transformed by [selection movement tools](./sel-move-tools.md). Pixels outside the bounds of the canvas can also be selected by certain tools.

diff --git a/shade-brush.md b/shade-brush.md
@@ -1,7 +1,7 @@
-# Shade Brush
-
 [`< Tools`](./tools.md)
 
+# Shade Brush
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/shade_brush.png)
 
 **Hotkey:** <kbd>D</kbd>

diff --git a/shape-tool.md b/shape-tool.md
@@ -1,7 +1,7 @@
-# Shape Tool
-
 [`< Tools`](./tools.md)
 
+# Shape Tool
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/shape_tool.png)
 
 **Hotkey:** <kbd>R</kbd>

diff --git a/shortcuts.md b/shortcuts.md
@@ -1,7 +1,7 @@
-# Shortcuts
-
 [`< Overview`](./README.md)
 
+# Shortcuts
+
 This page lists the keyboard shortcuts in *Stipple Effect*.
 
 Tool hotkeys can be found [here](./tools.md).

diff --git a/sizing.md b/sizing.md
@@ -1,7 +1,7 @@
-# Sizing and frame control
-
 [`< Overview`](./README.md)
 
+# Sizing and frame control
+
 The [project](./project.md) canvas is a rectangle of certain pixel dimensions. Both the width and height of the canvas must be positive (`w,h > 0`).
 
 Currently, the maximum dimensions for a *Stipple Effect* project are **1920 pixels wide** and **1080 pixels high**. This will likely increase in a future update.

diff --git a/state-control.md b/state-control.md
@@ -1,7 +1,7 @@
-# State control
-
 [`< Overview`](./README.md)
 
+# State control
+
 Most program actions in *Stipple Effect* constitute **edits**, and thus change the [project state](./project.md#state). It is important for users to be able to navigate between project states to revert to earlier or later states, in case of mistakes or simply for reference.
 
 ## State manager

diff --git a/stipple-pencil.md b/stipple-pencil.md
@@ -1,7 +1,7 @@
-# Stipple Pencil
-
 [`< Tools`](./tools.md)
 
+# Stipple Pencil
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/stipple_pencil.png)
 
 **Hotkey:** <kbd>O</kbd>

diff --git a/text-tool.md b/text-tool.md
@@ -1,7 +1,7 @@
-# Text Tool
-
 [`< Tools`](./tools.md)
 
+# Text Tool
+
 **Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/text_tool.png)
 
 **Hotkey:** <kbd>T</kbd>