Skip to content

Commit 884f4bb

Browse files
authored
Refactor structure and fix broken links in documentation (#4246)
* Refactor structure and fix broken links in documentation * Consolidated 'Context Menu' and 'Block Context Menu'
1 parent ea748ae commit 884f4bb

File tree

2 files changed

+57
-83
lines changed

2 files changed

+57
-83
lines changed

documentation/README.md

Lines changed: 57 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,18 @@ You can run it from
2727

2828
1. [Getting Started](#1-getting-started)
2929
2. [Toolbars](#2-toolbars)
30-
3. [Context Menu](#3-context-menu)
31-
4. [The Block Context Menu](#4-the-block-context-menu)
32-
1. [Extract Option](#41-extract-option)
33-
2. [Duplicate Option](#42-duplicate-option)
34-
3. [Delete Option](#43-delete-option)
35-
4. [Help Option](#44-help-option)
36-
5. [Keyboard Shortcuts](#5-keyboard-shortcuts)
37-
6. [Block Palettes](#6-block-palettes)
38-
1. [Defining a Note](#61-defining-a-note)
39-
2. [A Quick Tour of Selected Blocks](#62-a-quick-tour-of-selected-blocks)
40-
7. [Flow Palette](#7-flow-palette)
41-
8. [Widget Palette](#8-widget-palette)
42-
9. [Stats](#9-stats)
43-
10. [Planet View](#10-planet-view)
30+
3. [Context Menus](#3-context-menus)
31+
1. [Contextual Menu for Blocks](#1-contextual-menu-for-blocks)
32+
2. [Contextual Menu for Background](#2-contextual-menu-for-background)
33+
3. [Pie Menus](#3-pie-menus)
34+
4. [Keyboard Shortcuts](#4-keyboard-shortcuts)
35+
5. [Block Palettes](#5-block-palettes)
36+
1. [Defining a Note](#1-defining-a-note)
37+
2. [A Quick Tour of Selected Blocks](#2-a-quick-tour-of-selected-blocks)
38+
6. [Flow Palette](#6-flow-palette)
39+
7. [Widget Palette](#7-widget-palette)
40+
8. [Stats](#8-stats)
41+
9. [Planet View](#9-planet-view)
4442

4543
## <a>1. Getting Started</a>
4644

@@ -163,93 +161,69 @@ Located at the lower right of the canvas, this small toolbar provides additional
163161

164162
---
165163

166-
### 6. Contextual Menu
167-
168-
#### Contextual Menu for Blocks:
169-
When you right-click on a block, the following options are available:
170-
- **Extract**: Detaches the selected block from its current position, making it a standalone entity.
171-
- **Move to Trash**: Deletes the selected block by moving it to the trash.
172-
- **Duplicate**: Creates an identical copy of the selected block for reuse.
173-
- **Help**: Provides detailed information about the functionality of the selected block.
174-
- **Close**: Closes the contextual menu.
175-
176-
#### Contextual Menu for Background:
177-
When you right-click on the background, the following options are available:
178-
- **Grid**: Toggles the display of a grid in the workspace for better alignment and organization.
179-
- **Set Pitch Preview**: Adjusts and previews pitches while working on a composition.
180-
- **Enable Horizontal Scrolling**: Allows horizontal navigation for easier management of large projects.
181-
- **Turtle Wrap Off**: Toggles the turtle wrap feature, which determines whether the turtle wraps around the canvas edges.
182-
- **Restore**: Reverts the workspace to its last saved state.
183-
- **Increase Block Size**: Enlarges the size of all blocks for better visibility.
184-
- **Decrease Block Size**: Shrinks the size of all blocks to save space.
185-
- **Expand/Collapse Block**: Expands or collapses individual blocks to show or hide their details.
186-
- **Show/Hide Block**: Toggles the visibility of selected blocks in the workspace.
187-
- **Home**: Centers the workspace view on the initial starting point.
188-
- **Close**: Exits the contextual menu.
189-
- **Search for Blocks**: Opens a search bar to locate specific blocks within the workspace.
190-
- **Collapse**: Collapses all blocks to their minimal state.
191-
- **Clean**: Organizes and tidies up the workspace by aligning blocks systematically.
192-
- **Select**: Enables selection mode for selecting multiple blocks or elements in the workspace.
193-
194-
---
195-
196-
### 7. Pie Menus
197-
198-
Many blocks in Music Blocks also feature "pie menus" that allow you to change block parameters quickly by selecting options from a circular menu that appears when you hover over the block.
199-
200-
---
201-
202-
For further details on how to use these toolbars effectively, you can refer to the [Turtle Blocks Documentation](https://github.com/sugarlabs/turtleblocksjs/tree/master/documentation).
203-
204-
205-
## <a>3. Context Menu</a>
164+
## <a>3. Context Menus</a>
206165

207166
[Back to Table of Contents](#table-of-contents)
208167

209168
Context menus are an important part of user interfaces that provide users with quick access to a set of actions relevant to the context in which they are working.The right-click context menu in Music Blocks provides several options for working with blocks and the workspace. To access the right-click context menu, simply right-click anywhere in the workspace.
210169

211-
## <a>4. The Block Context Menu</a>
212-
213-
[Back to Table of Contents](#table-of-contents)
214-
170+
### <a>1. Contextual Menu for Blocks:</a>
215171

216-
This context menu appears when you right-click on a block in the workspace. It provides options such as "Duplicate," "Delete," "Help," and "Copy to Palette." The "Duplicate" option creates a copy of the selected block, while the "Delete" option removes the selected block from the workspace. The "Help" option opens a help dialog for the selected block, and the "Copy to Palette" option adds the selected block to the user's custom block palette.
172+
When you **right-click on a block**, the following options are available:
217173

218174
![Right-click context menu](./block_context.png "Right-click context menu")
219175

176+
**Extract**: The Extract option allows you to break down a nested block into its individual components or sub-blocks. This is useful for isolating parts of a block that you want to modify or reuse in other sections of your project, without affecting the original structure. It simplifies the process of working with complex, multi-layered blocks.
220177

221-
# Extract
178+
![Extract the selected block](./extract.png "Extract the selected block" )
222179

223-
The "Extract" option in Music Blocks allows you to separate a nested block into its individual components or sub-blocks. This can be useful if you want to modify or reuse specific parts of a block without affecting the rest of the block.
180+
**Move to Trash**: The Move to Trash option deletes the selected block by sending it to the trash. This action removes the block from your workspace, is a way of cleaning up the environment or removing blocks you no longer need.
224181

225-
![Extract the selected block](./extract.png "Extract the selected block")
182+
![Delete](./delete.png "Delete")
226183

184+
**Duplicate**: The Duplicate option creates an exact copy of the selected block. This is especially helpful for reusing blocks with the same configurations or settings in multiple places in your project, saving time and effort in recreating similar blocks.
227185

228-
# Duplicate
186+
![Duplicate](./duplicate.png "Duplicate")
229187

188+
**Help**: The Help option displays a detailed help screen for the selected block. This screen provides valuable information about the block’s functionality, purpose, and usage instructions, making it easier for users to understand and effectively incorporate the block into their projects.
230189

231-
This option creates a duplicate of the selected block and places it next to the original block.
190+
![Help](./help.png "Help")
232191

233-
![Duplicate](./duplicate.png "Duplicate")
192+
**Close**: The Close option exits the context menu, allowing you to return to your workspace without making any changes or selections. This is useful for dismissing the menu if you opened it by mistake or decided not to perform any action.
234193

194+
By using the right-click context menu in Music Blocks, you can quickly perform common tasks and manipulate blocks on the workspace. This can help you to work more efficiently and effectively in your projects.
235195

236-
# Delete
196+
### <a>2. Contextual Menu for Background:</a>
237197

238-
This option removes the selected block from your program
198+
When you **right-click on the background**, the following options are available:
239199

240-
![Delete](./delete.png "Delete")
241-
242-
# Help
200+
![Context-Menu-For-Workspace](./context-menu-workspace.png "Context Menu for Workspace")
243201

202+
- **Grid**: Toggles the display of a grid in the workspace for better alignment and organization.
203+
- **Set Pitch Preview**: Adjusts and previews pitches while working on a composition.
204+
- **Enable Horizontal Scrolling**: Allows horizontal navigation for easier management of large projects.
205+
- **Turtle Wrap Off**: Toggles the turtle wrap feature, which determines whether the turtle wraps around the canvas edges.
206+
- **Restore**: Reverts the workspace to its last saved state.
207+
- **Increase Block Size**: Enlarges the size of all blocks for better visibility.
208+
- **Decrease Block Size**: Shrinks the size of all blocks to save space.
209+
- **Expand/Collapse Block**: Expands or collapses individual blocks to show or hide their details.
210+
- **Show/Hide Block**: Toggles the visibility of selected blocks in the workspace.
211+
- **Home**: Centers the workspace view on the initial starting point.
212+
- **Close**: Exits the contextual menu.
213+
- **Search for Blocks**: Opens a search bar to locate specific blocks within the workspace.
214+
- **Collapse**: Collapses all blocks to their minimal state.
215+
- **Clean**: Organizes and tidies up the workspace by aligning blocks systematically.
216+
- **Select**: Enables selection mode for selecting multiple blocks or elements in the workspace.
244217

245-
This option shows a help screen with information about the selected block. You can use this option to learn more about the block's functionality and how to use it in your projects.
218+
### <a>3. Pie Menus </a>
246219

247-
![Help](./help.png "Help")
220+
Many blocks in Music Blocks also feature "pie menus" that allow you to change block parameters quickly by selecting options from a circular menu that appears when you hover over the block.
248221

249-
By using the right-click context menu in Music Blocks, you can quickly perform common tasks and manipulate blocks on the workspace. This can help you to work more efficiently and effectively in your projects.
222+
For further details on how to use these toolbars effectively, you can refer to the [Turtle Blocks Documentation](https://github.com/sugarlabs/turtleblocksjs/tree/master/documentation).
250223

224+
---
251225

252-
## Keyboard shortcuts
226+
## 4. Keyboard shortcuts
253227

254228

255229
[Back to Table of Contents](#table-of-contents)
@@ -272,7 +246,7 @@ You can directly type notes using _d_ for `Do`, _r_ for `Re`, _m_ for
272246
`Mi`, _f_ for `Fa`, _s_ for `Sol`, _l_ for `La`, and _t_ for `Ti`.
273247

274248

275-
## Block Palettes
249+
## 5. Block Palettes
276250

277251

278252
[Back to Table of Contents](#table-of-contents)
@@ -297,7 +271,7 @@ All of the other palettes are described in the
297271
[Turtle Blocks documentation pages](http://github.com/sugarlabs/turtleblocksjs/tree/master/documentation).
298272

299273

300-
## Defining a note
274+
### 1. Defining a note
301275

302276
![The Note Block](./newnote_block.svg "the note")
303277

@@ -346,7 +320,7 @@ will play together as a chord. You can also insert graphics blocks
346320
inside a note in order to create sound-sync animations.
347321

348322

349-
## A quick tour of selected blocks
323+
### 2. A quick tour of selected blocks
350324

351325

352326
![The Set Instrument block](./settimbre_block.svg "Set instrument block")
@@ -533,7 +507,7 @@ karaoke. [RUN LIVE](https://musicblocks.sugarlabs.org/index.html?id=173217248337
533507

534508

535509

536-
## Flow Palette
510+
## 6. Flow Palette
537511
[Back to Table of Contents](#table-of-contents)
538512

539513

@@ -559,7 +533,7 @@ to create a series of strings: "action1", "action2", ...,
559533
![Do](./do-actions.svg "Do actions")
560534

561535

562-
## Widget Palette
536+
## 7. Widget Palette
563537

564538

565539
[Back to Table of Contents](#table-of-contents)
@@ -587,7 +561,7 @@ familiar with math).
587561
*Pitch-time Matrix* blocks clamp is used to define the matrix:
588562
A row in the matrix is created for each *Pitch* block and columns are
589563
created for individual notes, which are created by using *Rhythm*
590-
blocks, individual note blocks, or the *Tuplet* block. [RUN LIVE](https://musicblocks.sugarlabs.org/index.html?id=1732827221942868&run=True)
564+
blocks, individual note blocks, or the *Tuplet* block. [RUN LIVE](https://musicblocks.sugarlabs.org/index.html?id=1732180386380311&run=True)
591565

592566

593567
![Rhythm](./rhythmruler2_block.svg "Rhythm block")
@@ -600,7 +574,7 @@ for a quarter note, etc. (Recall that in traditional Western notation
600574
all note values are (1) in powers of two, and are (2) in relation to
601575
the "whole note", which is in turn (3) defined by tempo, or
602576
beats&mdash;usually quarter notes&mdash;per minute) Each note is
603-
represented by a column in the matrix. [RUN LIVE](https://musicblocks.sugarlabs.org/index.html?id=1732457552545828&run=True)
577+
represented by a column in the matrix. <!-- [RUN LIVE]() -->
604578

605579
Special ratios of the whole note can be created very easily with the
606580
_Rhythm_ block by choosing an integer other than the traditional
@@ -647,7 +621,7 @@ More details about all of the widgets are available in the
647621
[Music Blocks Programming Guide](http://github.com/sugarlabs/musicblocks/tree/master/guide/README.md).
648622

649623

650-
## Stats
624+
## 8. Stats
651625

652626

653627
[Back to Table of Contents](#table-of-contents)
@@ -658,7 +632,7 @@ toolbar in advanced mode.
658632
![Stats](./stats.svg "Stats Details")
659633

660634

661-
## Planet View
635+
## 9. Planet View
662636

663637

664638
[Back to Table of Contents](#table-of-contents)
1 MB
Loading

0 commit comments

Comments
 (0)