From 92b3ae26bec4c3abb15f5a6f53e14bfb1c55502a Mon Sep 17 00:00:00 2001 From: "Charles K. Neimog" Date: Wed, 4 Dec 2024 18:46:19 -0300 Subject: [PATCH] doc updates --- Documentation/patch/gui.md | 6 ++ Documentation/patch/problems/index.md | 8 --- Documentation/patch/problems/memory.md | 4 +- .../patch/problems/where-they-live.md | 42 ++++++++++++++ mkdocs.yml | 58 +++++++++---------- 5 files changed, 78 insertions(+), 40 deletions(-) delete mode 100644 Documentation/patch/problems/index.md create mode 100644 Documentation/patch/problems/where-they-live.md diff --git a/Documentation/patch/gui.md b/Documentation/patch/gui.md index df5ab03f..625a7a92 100644 --- a/Documentation/patch/gui.md +++ b/Documentation/patch/gui.md @@ -1,7 +1,10 @@

Here we list all the objects that are supported by the GUI module and how to use them inside your web patch. +

+!!! danger "Set Senders and Receivers for GUI Objects" + Again, to use **any** GUI object (except for `vu`), you **must** configure senders and receivers. This ensures all objects function properly and saves you from spending excessive time debugging your patch.
- :material-gesture-double-tap:{ .lg .middle } __With `plaits~` from else__ @@ -67,3 +70,6 @@ All `Gui` objects include options to `send` and `receive` symbols, which are ess - **Sending messages to the Website**: Use the `receive` symbol with a `send` or `s` object to send messages from the Pd Patch to the Website. Note that `pd4web` does not automatically intercept connections between objects, so you must explicitly use the `send` and `receive` objects to connect the GUI objects for proper communication between the Pd Patch and the Website. + +!!! danger "Set Senders and Receivers for GUI Objects" + Again, to use **any** GUI object (except for `vu`), you **must** configure senders and receivers. This ensures all objects function properly and saves you from spending excessive time debugging your patch. diff --git a/Documentation/patch/problems/index.md b/Documentation/patch/problems/index.md deleted file mode 100644 index 365405d8..00000000 --- a/Documentation/patch/problems/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Errors and how to solve them - -!!! bug "How to report?" -

Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues){target="_blank}" or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7){target="_blank"}.

- -In this section, I will explain some problems related with configuration of `pd4web` and how to solve then. - -This problems are seem from browser console. To see the console you need to open the developer tools of your browser. You can do this pressing `F12` in your keyboard. Then check if the `console` tab is selected. \ No newline at end of file diff --git a/Documentation/patch/problems/memory.md b/Documentation/patch/problems/memory.md index 08814a96..30a8bc79 100644 --- a/Documentation/patch/problems/memory.md +++ b/Documentation/patch/problems/memory.md @@ -8,7 +8,7 @@

Memory problems

!!! bug "How to report?" -

Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues){target="_blank}" or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7){target="_blank"}.

+

Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues){target="_blank"} or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7){target="_blank"}.

You need to define the size of memory of your patch, this is pretty simple. Big patches needs more memory, small patches needs less memory. @@ -17,4 +17,4 @@ If you run a big patch with a small memory size you will get one error like this !!! danger "Aborted(Cannot enlarge memory arrays to size 134225920 bytes (OOM)." -If you see this, you need to increase the memory size. You can do this in the `pd4web` configuration, using the memory input on Pd patch or the `--memory` flag in the command line. \ No newline at end of file +If you see this, you need to increase the memory size. You can do this in the `pd4web` configuration, using the memory input on Pd patch or the `--memory` flag in the command line. diff --git a/Documentation/patch/problems/where-they-live.md b/Documentation/patch/problems/where-they-live.md new file mode 100644 index 00000000..6f620b3e --- /dev/null +++ b/Documentation/patch/problems/where-they-live.md @@ -0,0 +1,42 @@ +# Errors: where I see then? + +

Errors: where I see then?

+ +Errors, like the memory, flutex and others are displayed in the browser's console. To help me debug effectively, it's essential to check the console logs for your browser. + +--- +### Google Chrome, Edge, Brave, Opera + +--- +
+- :fontawesome-brands-chrome: :fontawesome-brands-edge: :simple-brave: :simple-opera: + * Open the browser and press `Ctrl + Shift + J` (Windows/Linux) or `Cmd + Option + J` (macOS). + * Alternatively, go to the menu: **1)** Click on the three-dot menu in the top-right corner. **2)** Navigate to More Tools > Developer Tools. **3)** - Select the Console tab. +
+ + + + + + +--- +### Mozilla Firefox + +--- +
+- :material-firefox: + * Open the browser and press `Ctrl + Shift + K` (Windows/Linux) or `Cmd + Option + K` (macOS). + * Alternatively, go to the menu: + Click on the hamburger menu in the top-right corner. + Navigate to Web Developer > Console. +
+ + + + + +--- + +!!! tip "Pro Tip" + Ensure to capture any errors or warnings displayed in the console. Screenshots or copied text can help us analyze the issue faster. + diff --git a/mkdocs.yml b/mkdocs.yml index b4081ca9..d31dde32 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,42 +65,40 @@ markdown_extensions: - def_list - pymdownx.tasklist: custom_checkbox: true - repo_url: https://github.com/charlesneimog/pd4web extra_css: [extra/extra.css] -#extra_javascript: [js/index_slider.js] +# extra_javascript: [js/index_slider.js] nav: - Home: index.md - Compile your patch: - Installation: patch/install.md - - Gui Objects: - - patch/gui.md - - Compilation: - - patch/compile.md - - Website Templates: - - patch/templates/index.md - - Website Templates List: - - patch/templates/1-score.md - - patch/templates/2-hands.md - - patch/templates/3-choir.md - - patch/templates/4-p5js.md - - patch/templates/5-tutorial.md - - Problems: - - patch/problems/memory.md - - patch/problems/compilation.md - - patch/problems/flutex.md - - Uploading your patch: - - patch/upload/github.md - - patch/upload/cloudflare.md - - patch/upload/others.md + - Gui Objects: [patch/gui.md] + - Compilation: [patch/compile.md] + - Website Templates: + - patch/templates/index.md + - Website Templates List: + - patch/templates/1-score.md + - patch/templates/2-hands.md + - patch/templates/3-choir.md + - patch/templates/4-p5js.md + - patch/templates/5-tutorial.md + - Problems: + - patch/problems/where-they-live.md + - patch/problems/memory.md + - patch/problems/compilation.md + - patch/problems/flutex.md + - Uploading your patch: + - patch/upload/github.md + - patch/upload/cloudflare.md + - patch/upload/others.md - libraries.md - - Pd4Web JavaScript Module: - - JavaScript Module: js/js.md - - js/requirements.md - - js/engine.md - - js/receive.md - - js/send.md - - js/midi.md + - Pd4Web JavaScript Module: + - JavaScript Module: js/js.md + - js/requirements.md + - js/engine.md + - js/receive.md + - js/send.md + - js/midi.md - devs.md # - Examples: tests/ plugins: @@ -108,7 +106,7 @@ plugins: - exclude: glob: [tests/**/Pd4Web/**] extra: - #alternate: + # alternate: # - name: English # link: /en # lang: en