diff --git a/app/lib/l10n/app_af.arb b/app/lib/l10n/app_af.arb index 72ac5bcc3d64..20cbc9bc07be 100644 --- a/app/lib/l10n/app_af.arb +++ b/app/lib/l10n/app_af.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ar.arb b/app/lib/l10n/app_ar.arb index c16041f902c2..e45ca2d5a5ff 100644 --- a/app/lib/l10n/app_ar.arb +++ b/app/lib/l10n/app_ar.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ca.arb b/app/lib/l10n/app_ca.arb index e6386375f70c..d2953e86163b 100644 --- a/app/lib/l10n/app_ca.arb +++ b/app/lib/l10n/app_ca.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_cs.arb b/app/lib/l10n/app_cs.arb index 19311beb3522..d154ea32ea25 100644 --- a/app/lib/l10n/app_cs.arb +++ b/app/lib/l10n/app_cs.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_da.arb b/app/lib/l10n/app_da.arb index 650fb5ff7e70..205f680fb0df 100644 --- a/app/lib/l10n/app_da.arb +++ b/app/lib/l10n/app_da.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_de.arb b/app/lib/l10n/app_de.arb index 7d9d4ed2c855..884f62c261b9 100644 --- a/app/lib/l10n/app_de.arb +++ b/app/lib/l10n/app_de.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_el.arb b/app/lib/l10n/app_el.arb index 934f2baf97f9..f02c345fb045 100644 --- a/app/lib/l10n/app_el.arb +++ b/app/lib/l10n/app_el.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_es.arb b/app/lib/l10n/app_es.arb index 768294302302..906e32c9bf75 100644 --- a/app/lib/l10n/app_es.arb +++ b/app/lib/l10n/app_es.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_fi.arb b/app/lib/l10n/app_fi.arb index 56117c5a84ff..c782a24f41e6 100644 --- a/app/lib/l10n/app_fi.arb +++ b/app/lib/l10n/app_fi.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_fr.arb b/app/lib/l10n/app_fr.arb index 9478b5db79a0..3984baefb414 100644 --- a/app/lib/l10n/app_fr.arb +++ b/app/lib/l10n/app_fr.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_he.arb b/app/lib/l10n/app_he.arb index def11ae29b8c..5cf9dd6c48bb 100644 --- a/app/lib/l10n/app_he.arb +++ b/app/lib/l10n/app_he.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_hi.arb b/app/lib/l10n/app_hi.arb index 24fb9e58b463..1d5e2348cb03 100644 --- a/app/lib/l10n/app_hi.arb +++ b/app/lib/l10n/app_hi.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_hu.arb b/app/lib/l10n/app_hu.arb index cfbd9db11495..1f54461672d4 100644 --- a/app/lib/l10n/app_hu.arb +++ b/app/lib/l10n/app_hu.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_id.arb b/app/lib/l10n/app_id.arb index 8035f385b765..7552a78b1146 100644 --- a/app/lib/l10n/app_id.arb +++ b/app/lib/l10n/app_id.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_it.arb b/app/lib/l10n/app_it.arb index 1800d11ed3c4..96cd523c9be1 100644 --- a/app/lib/l10n/app_it.arb +++ b/app/lib/l10n/app_it.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ja.arb b/app/lib/l10n/app_ja.arb index 484d95bff56d..86850f55bcea 100644 --- a/app/lib/l10n/app_ja.arb +++ b/app/lib/l10n/app_ja.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ko.arb b/app/lib/l10n/app_ko.arb index 186778abd2f2..ae2606a0a1e1 100644 --- a/app/lib/l10n/app_ko.arb +++ b/app/lib/l10n/app_ko.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_nl.arb b/app/lib/l10n/app_nl.arb index 0485166e166e..c773224c6ad3 100644 --- a/app/lib/l10n/app_nl.arb +++ b/app/lib/l10n/app_nl.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_no.arb b/app/lib/l10n/app_no.arb index e041f586143c..678a3473a122 100644 --- a/app/lib/l10n/app_no.arb +++ b/app/lib/l10n/app_no.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_or.arb b/app/lib/l10n/app_or.arb index 095952244282..ff82538dec59 100644 --- a/app/lib/l10n/app_or.arb +++ b/app/lib/l10n/app_or.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_pl.arb b/app/lib/l10n/app_pl.arb index e03b07049273..0d4b741562e9 100644 --- a/app/lib/l10n/app_pl.arb +++ b/app/lib/l10n/app_pl.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_pt.arb b/app/lib/l10n/app_pt.arb index 8b1b2058d006..5a37506eb4e3 100644 --- a/app/lib/l10n/app_pt.arb +++ b/app/lib/l10n/app_pt.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_pt_BR.arb b/app/lib/l10n/app_pt_BR.arb index 8b8fd8f1c1b5..d9e80ee69e98 100644 --- a/app/lib/l10n/app_pt_BR.arb +++ b/app/lib/l10n/app_pt_BR.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ro.arb b/app/lib/l10n/app_ro.arb index c4376828c5b6..4e7a409bc77f 100644 --- a/app/lib/l10n/app_ro.arb +++ b/app/lib/l10n/app_ro.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_ru.arb b/app/lib/l10n/app_ru.arb index bca70893b4cf..ae3f77a50c0e 100644 --- a/app/lib/l10n/app_ru.arb +++ b/app/lib/l10n/app_ru.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_sr.arb b/app/lib/l10n/app_sr.arb index 8ae1cc9e9001..691cc4a3c731 100644 --- a/app/lib/l10n/app_sr.arb +++ b/app/lib/l10n/app_sr.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_sv.arb b/app/lib/l10n/app_sv.arb index 55bac1b383b0..b1c645449bf1 100644 --- a/app/lib/l10n/app_sv.arb +++ b/app/lib/l10n/app_sv.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_th.arb b/app/lib/l10n/app_th.arb index 482ad2542c47..d1a9709ca7c7 100644 --- a/app/lib/l10n/app_th.arb +++ b/app/lib/l10n/app_th.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_tr.arb b/app/lib/l10n/app_tr.arb index 5947cc50c1c8..dd428c0fe5a4 100644 --- a/app/lib/l10n/app_tr.arb +++ b/app/lib/l10n/app_tr.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_uk.arb b/app/lib/l10n/app_uk.arb index 1ea4b1eda388..e62ef51711d8 100644 --- a/app/lib/l10n/app_uk.arb +++ b/app/lib/l10n/app_uk.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_vi.arb b/app/lib/l10n/app_vi.arb index 1fa8f33b13f9..72b24f173942 100644 --- a/app/lib/l10n/app_vi.arb +++ b/app/lib/l10n/app_vi.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_zh-Hant.arb b/app/lib/l10n/app_zh-Hant.arb index 015493dee09f..3707fc1ae83f 100644 --- a/app/lib/l10n/app_zh-Hant.arb +++ b/app/lib/l10n/app_zh-Hant.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/app/lib/l10n/app_zh.arb b/app/lib/l10n/app_zh.arb index 3b220c81de8f..042247df2310 100644 --- a/app/lib/l10n/app_zh.arb +++ b/app/lib/l10n/app_zh.arb @@ -1318,5 +1318,8 @@ "type": "int" } } - } + }, + "holdShortcuts": "Hold Shortcuts", + "holdShortcutsDescription": "Hold a key to temporarily switch to another tool. Releasing the key switches back to the previous tool.", + "key": "Key" } \ No newline at end of file diff --git a/docs/src/content/docs/af/community/faq.md b/docs/src/content/docs/af/community/faq.md index 4acffe2401e7..8acfa6f91b13 100644 --- a/docs/src/content/docs/af/community/faq.md +++ b/docs/src/content/docs/af/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/af/community/stylus-support.md b/docs/src/content/docs/af/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/af/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/af/docs/v2/add.md b/docs/src/content/docs/af/docs/v2/add.md index b45904f0c13d..7f6c686dd252 100644 --- a/docs/src/content/docs/af/docs/v2/add.md +++ b/docs/src/content/docs/af/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Voer in -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Gereedskap -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/af/docs/v2/collaboration.md b/docs/src/content/docs/af/docs/v2/collaboration.md index 71fd0d370edc..6f9bce905d13 100644 --- a/docs/src/content/docs/af/docs/v2/collaboration.md +++ b/docs/src/content/docs/af/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/af/docs/v2/intro.mdx b/docs/src/content/docs/af/docs/v2/intro.mdx index 007be47090d1..651749a69a2f 100644 --- a/docs/src/content/docs/af/docs/v2/intro.mdx +++ b/docs/src/content/docs/af/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/af/docs/v2/layers.md b/docs/src/content/docs/af/docs/v2/layers.md index 396fdce9b9c2..4583dcb7c0e9 100644 --- a/docs/src/content/docs/af/docs/v2/layers.md +++ b/docs/src/content/docs/af/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/af/docs/v2/pack.md b/docs/src/content/docs/af/docs/v2/pack.md index f3d361337cea..4553dcbc2581 100644 --- a/docs/src/content/docs/af/docs/v2/pack.md +++ b/docs/src/content/docs/af/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pak --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Style @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palette -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/af/docs/v2/pages.md b/docs/src/content/docs/af/docs/v2/pages.md index 6d34756c99e8..707dd5cf61fc 100644 --- a/docs/src/content/docs/af/docs/v2/pages.md +++ b/docs/src/content/docs/af/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Bladsye --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/af/docs/v2/shortcuts.md b/docs/src/content/docs/af/docs/v2/shortcuts.md index 643c39aaa020..242dd8053370 100644 --- a/docs/src/content/docs/af/docs/v2/shortcuts.md +++ b/docs/src/content/docs/af/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Pen -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/af/docs/v2/storage.md b/docs/src/content/docs/af/docs/v2/storage.md index fd3aae4e7ea8..70dc2158e80d 100644 --- a/docs/src/content/docs/af/docs/v2/storage.md +++ b/docs/src/content/docs/af/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Data-gids -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/af/docs/v2/templates.md b/docs/src/content/docs/af/docs/v2/templates.md index 4bdf64f5c9f7..5568d0dd7489 100644 --- a/docs/src/content/docs/af/docs/v2/templates.md +++ b/docs/src/content/docs/af/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Sjablone In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/af/docs/v2/utilities.md b/docs/src/content/docs/af/docs/v2/utilities.md index 046f888bfcbf..3753277b6c2f 100644 --- a/docs/src/content/docs/af/docs/v2/utilities.md +++ b/docs/src/content/docs/af/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Lêer -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/af/downloads/web.mdx b/docs/src/content/docs/af/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/af/downloads/web.mdx +++ b/docs/src/content/docs/af/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/ar/community/faq.md b/docs/src/content/docs/ar/community/faq.md index 99d2f72d7005..4d078bea39d0 100644 --- a/docs/src/content/docs/ar/community/faq.md +++ b/docs/src/content/docs/ar/community/faq.md @@ -23,6 +23,8 @@ title: الأسئلة المتكررة > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + أنا أستخدم المدخل الذي يوفره إطار التردد. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ This is the issue to track it: [flutter/flutter#42846](https://github.com/flutte > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + أنا أستخدم المدخل الذي يوفره إطار التردد. هناك بالفعل مشاكل لتعقبها: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) و [flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ar/community/stylus-support.md b/docs/src/content/docs/ar/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ar/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ar/docs/v2/add.md b/docs/src/content/docs/ar/docs/v2/add.md index 89383f887ac2..6c3d466e6669 100644 --- a/docs/src/content/docs/ar/docs/v2/add.md +++ b/docs/src/content/docs/ar/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## استيراد -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## أدوات -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ar/docs/v2/collaboration.md b/docs/src/content/docs/ar/docs/v2/collaboration.md index 080bf3d5fa80..0d474d72e2f1 100644 --- a/docs/src/content/docs/ar/docs/v2/collaboration.md +++ b/docs/src/content/docs/ar/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ar/docs/v2/intro.mdx b/docs/src/content/docs/ar/docs/v2/intro.mdx index adff85867813..0ff49be83785 100644 --- a/docs/src/content/docs/ar/docs/v2/intro.mdx +++ b/docs/src/content/docs/ar/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ar/docs/v2/layers.md b/docs/src/content/docs/ar/docs/v2/layers.md index 292eb4d103f5..0735d97df118 100644 --- a/docs/src/content/docs/ar/docs/v2/layers.md +++ b/docs/src/content/docs/ar/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ar/docs/v2/pack.md b/docs/src/content/docs/ar/docs/v2/pack.md index 7a4d3c00cc9f..194bb79b778c 100644 --- a/docs/src/content/docs/ar/docs/v2/pack.md +++ b/docs/src/content/docs/ar/docs/v2/pack.md @@ -2,7 +2,7 @@ title: حُزْمَة --- -A pack is a collection of components that can be used in the stamp tool. يمكنك إنشاء حزمة خاصة بك أو استيراد حزمة موجودة. لهذا انقر فوق الزاوية اليسرى العلوية وانقر على "الحزم". +A pack is a collection of components that can be used in the stamp tool. يمكنك إنشاء حزمة خاصة بك أو استيراد حزمة موجودة. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## الأنماط @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## ألواح الألوان -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ar/docs/v2/pages.md b/docs/src/content/docs/ar/docs/v2/pages.md index b078601adac1..5e2e548dc2e0 100644 --- a/docs/src/content/docs/ar/docs/v2/pages.md +++ b/docs/src/content/docs/ar/docs/v2/pages.md @@ -2,7 +2,7 @@ title: الصفحات --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ar/docs/v2/shortcuts.md b/docs/src/content/docs/ar/docs/v2/shortcuts.md index c2b023381270..b26d4bd32917 100644 --- a/docs/src/content/docs/ar/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ar/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: الاختصارات ## القلم -بشكل افتراضي، يتم تكوين القلم ليعمل كالتالي: +By default, the pen is configured to function as the following: - `القضية`: تم تكوينها كقلم. - 'أولا\\` (الزر الأساسي، إذا كان مدعوماً): قم بتغيير الأداة اليدوية أثناء الضغط عليها. diff --git a/docs/src/content/docs/ar/docs/v2/storage.md b/docs/src/content/docs/ar/docs/v2/storage.md index 9e7572c3915e..f414fa774d8d 100644 --- a/docs/src/content/docs/ar/docs/v2/storage.md +++ b/docs/src/content/docs/ar/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## دليل البيانات -دليل البيانات هو الدليل الذي يتم فيه تخزين الوثائق والقوالب والحزم. -على سطح المكتب يمكنك العثور عليه في `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. على الهاتف المحمول في `getExternalFilesDir(null)/Linwood/Butterfly`. يمكنك أيضا تغييره في الإعدادات تحت `البيانات`. @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## المنصات الأصلية -بشكل افتراضي يحفظ التطبيق البيانات في مجلد المستندات الخاص بك في مجلد فرعي يسمى "لينود/الفراغة". يتم إنشاء هذا المجلد عند حفظ البيانات الأولى. يمكن تغيير هذا المجلد في الإعدادات. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. يمكن تغيير هذا المجلد في الإعدادات. ## التخزين البعيد {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -يمكن حفظ التطبيق في خادم بعيد. هذا مفيد إذا كنت تريد مشاركة البيانات مع أشخاص آخرين أو إذا كان لديك أجهزة كمبيوتر متعددة. حاليا لا يدعم سوى بروتوكول "WebDAV". +The application data can be stored on a remote server. هذا مفيد إذا كنت تريد مشاركة البيانات مع أشخاص آخرين أو إذا كان لديك أجهزة كمبيوتر متعددة. حاليا لا يدعم سوى بروتوكول "WebDAV". لإضافة خادم بعيد ، انتقل إلى الإعدادات وانقر على `بعيد`. ثم انقر على `إضافة جهاز التحكم عن بعد`. ثم انقر على `إضافة جهاز التحكم عن بعد`. إضافة عنوان URL للخادم البعيد واسم المستخدم وكلمة المرور. بعد ذلك يمكنك تحديد المجلد حيث يتم تخزين البيانات. -للحصول على عنوان ويب داف، يرجى زيارة الوثائق: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (يجب أن يبدو مثل هذا: `https://nextcloud.example.com/remote.php/dav/files/username/`، استبدال `username' و `nextcloud.example.com\\` بالقيم الصحيحة) @@ -55,8 +55,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## طرق التخزين الأخرى إذا كنت على جهاز أصلي يمكنك أيضا مزامنة دليل التطبيق مع المنصة المفضلة لديك. -يحتوي محرك الأقراص Google على [تطبيق رسمي](https://www.google.com/drive/download/) على النوافذ وهناك حالات غير رسمية على متجر اللعب. -على Linux يمكنك أيضًا استخدام نظام التخزين المحلي البعيد وتغيير دليل البيانات الخاص بك إلى هذا أو إضافة وحدة تخزين خارجية جديدة إذا قمت بالنقر على زر إضافة الاتصال. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ar/docs/v2/templates.md b/docs/src/content/docs/ar/docs/v2/templates.md index e87a0ac1eb38..656065cbeff5 100644 --- a/docs/src/content/docs/ar/docs/v2/templates.md +++ b/docs/src/content/docs/ar/docs/v2/templates.md @@ -4,7 +4,7 @@ title: قوالب In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ar/docs/v2/utilities.md b/docs/src/content/docs/ar/docs/v2/utilities.md index e7833cb6a528..18d0e830889c 100644 --- a/docs/src/content/docs/ar/docs/v2/utilities.md +++ b/docs/src/content/docs/ar/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## ملف -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## الكاميرا diff --git a/docs/src/content/docs/ar/downloads/web.mdx b/docs/src/content/docs/ar/downloads/web.mdx index 94bfea6a2abf..a5f217ca8c75 100644 --- a/docs/src/content/docs/ar/downloads/web.mdx +++ b/docs/src/content/docs/ar/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; هذا تطبيق تدريجي على الويب. يمكنك تثبيته على المتصفح الخاص بك واستخدامه دون اتصال. يتم تخزين جميع البيانات في المتصفح الخاص بك. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## الروابط diff --git a/docs/src/content/docs/ca/community/faq.md b/docs/src/content/docs/ca/community/faq.md index f826c066803f..919bb3582bf3 100644 --- a/docs/src/content/docs/ca/community/faq.md +++ b/docs/src/content/docs/ca/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ca/community/stylus-support.md b/docs/src/content/docs/ca/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ca/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ca/docs/v2/add.md b/docs/src/content/docs/ca/docs/v2/add.md index f4434f8360fe..42a7d902fc01 100644 --- a/docs/src/content/docs/ca/docs/v2/add.md +++ b/docs/src/content/docs/ca/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importa -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Eines -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ca/docs/v2/collaboration.md b/docs/src/content/docs/ca/docs/v2/collaboration.md index b2bb40836b1a..c4ee1ea08a0d 100644 --- a/docs/src/content/docs/ca/docs/v2/collaboration.md +++ b/docs/src/content/docs/ca/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ca/docs/v2/intro.mdx b/docs/src/content/docs/ca/docs/v2/intro.mdx index 71e88c2d1adf..5fedb7aacbc5 100644 --- a/docs/src/content/docs/ca/docs/v2/intro.mdx +++ b/docs/src/content/docs/ca/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ca/docs/v2/layers.md b/docs/src/content/docs/ca/docs/v2/layers.md index 09d982b5b39d..e5f234e71069 100644 --- a/docs/src/content/docs/ca/docs/v2/layers.md +++ b/docs/src/content/docs/ca/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ca/docs/v2/pack.md b/docs/src/content/docs/ca/docs/v2/pack.md index 277f5c6c0485..3320ad6221f6 100644 --- a/docs/src/content/docs/ca/docs/v2/pack.md +++ b/docs/src/content/docs/ca/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pack --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Estils @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Paletes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ca/docs/v2/pages.md b/docs/src/content/docs/ca/docs/v2/pages.md index 4a10eb238601..f53d853a5220 100644 --- a/docs/src/content/docs/ca/docs/v2/pages.md +++ b/docs/src/content/docs/ca/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pàgines --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ca/docs/v2/shortcuts.md b/docs/src/content/docs/ca/docs/v2/shortcuts.md index df0d1f46f0e3..107ffd04c997 100644 --- a/docs/src/content/docs/ca/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ca/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Bolígraf -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/ca/docs/v2/storage.md b/docs/src/content/docs/ca/docs/v2/storage.md index 64f622785c89..db6327f9ad0d 100644 --- a/docs/src/content/docs/ca/docs/v2/storage.md +++ b/docs/src/content/docs/ca/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Directori de dades -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ca/docs/v2/templates.md b/docs/src/content/docs/ca/docs/v2/templates.md index cc100e02a932..1588b55a0ad1 100644 --- a/docs/src/content/docs/ca/docs/v2/templates.md +++ b/docs/src/content/docs/ca/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Plantilles In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ca/docs/v2/utilities.md b/docs/src/content/docs/ca/docs/v2/utilities.md index e10d75133a2b..d57f2f84ebe9 100644 --- a/docs/src/content/docs/ca/docs/v2/utilities.md +++ b/docs/src/content/docs/ca/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fitxer -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Càmera diff --git a/docs/src/content/docs/ca/downloads/web.mdx b/docs/src/content/docs/ca/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/ca/downloads/web.mdx +++ b/docs/src/content/docs/ca/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/cs/community/faq.md b/docs/src/content/docs/cs/community/faq.md index 2207fe686aa3..02d9fc2ce23b 100644 --- a/docs/src/content/docs/cs/community/faq.md +++ b/docs/src/content/docs/cs/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/cs/community/stylus-support.md b/docs/src/content/docs/cs/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/cs/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/cs/docs/v2/add.md b/docs/src/content/docs/cs/docs/v2/add.md index 09d6bfa995c2..276bd85024ed 100644 --- a/docs/src/content/docs/cs/docs/v2/add.md +++ b/docs/src/content/docs/cs/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importovat -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Nástroje a nářadí -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/cs/docs/v2/collaboration.md b/docs/src/content/docs/cs/docs/v2/collaboration.md index ca08f79fec2e..5f8f2884593e 100644 --- a/docs/src/content/docs/cs/docs/v2/collaboration.md +++ b/docs/src/content/docs/cs/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/cs/docs/v2/intro.mdx b/docs/src/content/docs/cs/docs/v2/intro.mdx index 9baca007df6c..e7e3f3bec594 100644 --- a/docs/src/content/docs/cs/docs/v2/intro.mdx +++ b/docs/src/content/docs/cs/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/cs/docs/v2/layers.md b/docs/src/content/docs/cs/docs/v2/layers.md index c79a279a4dfb..a8442454f87e 100644 --- a/docs/src/content/docs/cs/docs/v2/layers.md +++ b/docs/src/content/docs/cs/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/cs/docs/v2/pack.md b/docs/src/content/docs/cs/docs/v2/pack.md index 6b2c00811af8..ff90356b7359 100644 --- a/docs/src/content/docs/cs/docs/v2/pack.md +++ b/docs/src/content/docs/cs/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Balení --- -A pack is a collection of components that can be used in the stamp tool. Můžete vytvořit vlastní balíček nebo importovat existující balíček. Pro tento klik v levém horním rohu klikněte na "Balíčky". +A pack is a collection of components that can be used in the stamp tool. Můžete vytvořit vlastní balíček nebo importovat existující balíček. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styly @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palety -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/cs/docs/v2/pages.md b/docs/src/content/docs/cs/docs/v2/pages.md index 3d29d8ac295d..6415dba1e2ab 100644 --- a/docs/src/content/docs/cs/docs/v2/pages.md +++ b/docs/src/content/docs/cs/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Stránky --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/cs/docs/v2/shortcuts.md b/docs/src/content/docs/cs/docs/v2/shortcuts.md index 4c2ddb960a8d..454be510a7c1 100644 --- a/docs/src/content/docs/cs/docs/v2/shortcuts.md +++ b/docs/src/content/docs/cs/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Některé z nich jsou zapsány pod tlačítky. ## Pec -Ve výchozím nastavení je pero nastaveno tak, aby fungovalo: +By default, the pen is configured to function as the following: - `Pen`: nakonfigurován jako pen. - `First` (Primární tlačítko, pokud je podporováno): Přepnout na ruční nástroj při stisknutí. diff --git a/docs/src/content/docs/cs/docs/v2/storage.md b/docs/src/content/docs/cs/docs/v2/storage.md index b0adc52659a1..17c945915228 100644 --- a/docs/src/content/docs/cs/docs/v2/storage.md +++ b/docs/src/content/docs/cs/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Datový adresář -Datový adresář je adresář, kde jsou uloženy dokumenty, šablony a balíčky. -Na počítači je můžete najít v `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Na mobilu je v `getExternalFilesDir(null)/Linwood/Butterfly`. Můžete to také změnit v nastavení pod `Data`. @@ -22,7 +22,7 @@ Otevřete nástroje vývojáře ve vašem prohlížeči a uvidíte data. ## Domácí nástupiště -Jako výchozí nastavení aplikace ukládá data ve složce dokumentů do podsložky nazvané "Linwood/Butterfly". Tato složka je vytvořena, když uložíte první data. Tuto složku lze změnit v nastavení. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Tuto složku lze změnit v nastavení. ## Vzdálené úložiště {#remote} @@ -32,12 +32,12 @@ Tato funkce není dostupná na webu. ::: -Aplikaci lze uložit na vzdálený server. To je užitečné, pokud chcete sdílet data s ostatními lidmi nebo pokud máte více počítačů. V současné době je podporován pouze protokol `WebDAV`. +The application data can be stored on a remote server. To je užitečné, pokud chcete sdílet data s ostatními lidmi nebo pokud máte více počítačů. V současné době je podporován pouze protokol `WebDAV`. Chcete-li přidat vzdálený server, přejděte do nastavení a klikněte na "Remotes". Poté klikněte na "Přidat vzdálené". Přidejte URL vzdáleného serveru a uživatelské jméno a heslo. Poté můžete specifikovat složku, kde jsou data uložena. -Chcete-li získat webdav url, navštivte dokumentaci: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (mělo by to vypadat takto: `https://nextcloud.example.com/remote.php/dav/files/username/`, nahraďte `username` a `nextcloud.example.com` správnými hodnotami) @@ -55,8 +55,8 @@ Existuje několik omezení: ## Jiné metody skladování Pokud jste na nativním zařízení, můžete také synchronizovat adresář aplikace s vaší oblíbenou platformou. -Google disk má [oficiální aplikaci](https://www.google.com/drive/download/) v oknech a v obchodě Play jsou neoficiální online. -Na linuxu můžete také použít nativní vzdálené úložiště a změnit v něm adresář dat nebo přidat nové externí úložiště, pokud klepnete na tlačítko Přidat připojení. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/cs/docs/v2/templates.md b/docs/src/content/docs/cs/docs/v2/templates.md index 79580f53f8eb..c7c2cfd2afdc 100644 --- a/docs/src/content/docs/cs/docs/v2/templates.md +++ b/docs/src/content/docs/cs/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Šablony In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/cs/docs/v2/utilities.md b/docs/src/content/docs/cs/docs/v2/utilities.md index 093c4a33cdfd..c9a1a6849d66 100644 --- a/docs/src/content/docs/cs/docs/v2/utilities.md +++ b/docs/src/content/docs/cs/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Soubor -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Fotoaparát diff --git a/docs/src/content/docs/cs/downloads/web.mdx b/docs/src/content/docs/cs/downloads/web.mdx index be77e9d27a88..cfcb20ca57a6 100644 --- a/docs/src/content/docs/cs/downloads/web.mdx +++ b/docs/src/content/docs/cs/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Odkazy diff --git a/docs/src/content/docs/da/community/faq.md b/docs/src/content/docs/da/community/faq.md index c1d9ef973eb4..9a45b0bbb999 100644 --- a/docs/src/content/docs/da/community/faq.md +++ b/docs/src/content/docs/da/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/da/community/stylus-support.md b/docs/src/content/docs/da/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/da/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/da/docs/v2/add.md b/docs/src/content/docs/da/docs/v2/add.md index c4a13bc33aa4..68241f70f880 100644 --- a/docs/src/content/docs/da/docs/v2/add.md +++ b/docs/src/content/docs/da/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importér -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Værktøjer -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/da/docs/v2/collaboration.md b/docs/src/content/docs/da/docs/v2/collaboration.md index 381461f2f76f..c5d00c468647 100644 --- a/docs/src/content/docs/da/docs/v2/collaboration.md +++ b/docs/src/content/docs/da/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/da/docs/v2/intro.mdx b/docs/src/content/docs/da/docs/v2/intro.mdx index 8516691afa4d..1f721e1aa514 100644 --- a/docs/src/content/docs/da/docs/v2/intro.mdx +++ b/docs/src/content/docs/da/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/da/docs/v2/layers.md b/docs/src/content/docs/da/docs/v2/layers.md index de664cb3a06a..2fcc440f7fac 100644 --- a/docs/src/content/docs/da/docs/v2/layers.md +++ b/docs/src/content/docs/da/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/da/docs/v2/pack.md b/docs/src/content/docs/da/docs/v2/pack.md index 77efc11bc327..843c84c0a8f4 100644 --- a/docs/src/content/docs/da/docs/v2/pack.md +++ b/docs/src/content/docs/da/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pakke --- -A pack is a collection of components that can be used in the stamp tool. Du kan oprette din egen pakke eller importere en eksisterende. For dette klik i øverste venstre hjørne og klik på "Pakker". +A pack is a collection of components that can be used in the stamp tool. Du kan oprette din egen pakke eller importere en eksisterende. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/da/docs/v2/pages.md b/docs/src/content/docs/da/docs/v2/pages.md index 1d1a44ef2abc..39ee58771c1f 100644 --- a/docs/src/content/docs/da/docs/v2/pages.md +++ b/docs/src/content/docs/da/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Sider --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/da/docs/v2/shortcuts.md b/docs/src/content/docs/da/docs/v2/shortcuts.md index 840943d49e49..96305e13d8cb 100644 --- a/docs/src/content/docs/da/docs/v2/shortcuts.md +++ b/docs/src/content/docs/da/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Nogle af dem er skrevet under knapperne. ## Pen -Som standard er pennen konfigureret til at fungere som følgende: +By default, the pen is configured to function as the following: - `Pen`: konfigureret som pen. - `Først` (Primær knap, hvis understøttet): Skift til håndværktøj under tryk. diff --git a/docs/src/content/docs/da/docs/v2/storage.md b/docs/src/content/docs/da/docs/v2/storage.md index 767c85abfb94..fe2e387a75a0 100644 --- a/docs/src/content/docs/da/docs/v2/storage.md +++ b/docs/src/content/docs/da/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Data mappe -Datamappen er den mappe, hvor dokumenter, skabeloner og pakker gemmes. -På skrivebordet kan du finde det i `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. På mobil det er i `getExternalFilesDir(null)/Linwood/Butterfly`. Du kan også ændre det i indstillingerne under `Data`. @@ -22,7 +22,7 @@ Applikationsdataene er gemt i din browser. Det opbevares på et lokalt lager. ## Indfødte platforme -Som standard gemmer programmet data i dine dokumenter mappe i en undermappe kaldet "Linwood/Butterfly". Denne mappe oprettes, når du gemmer de første data. Denne mappe kan ændres i indstillingerne. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Denne mappe kan ændres i indstillingerne. ## Ekstern lagerplads {#remote} @@ -32,12 +32,12 @@ Denne funktion er ikke tilgængelig på nettet. ::: -Programmet kan gemmes på en ekstern server. Dette er nyttigt, hvis du ønsker at dele data med andre mennesker, eller hvis du har flere computere. I øjeblikket er kun 'WebDAV'-protokollen understøttet. +The application data can be stored on a remote server. Dette er nyttigt, hvis du ønsker at dele data med andre mennesker, eller hvis du har flere computere. I øjeblikket er kun 'WebDAV'-protokollen understøttet. For at tilføje en fjernserver, gå til indstillingerne og klik på `Remotes`. Klik derefter på `Tilføj fjern`. Tilføj webadressen på den eksterne server og brugernavn og adgangskode. Derefter kan du angive mappen, hvor dataene er gemt. -For at få webdav url, besøg dokumentationen: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (det skal se sådan ud: `https://nextcloud.example.com/remote.php/dav/files/username/`, erstat `username` og `nextcloud.example.com` med de korrekte værdier) @@ -55,8 +55,8 @@ Der er et par begrænsninger: ## Andre oplagringsmetoder Hvis du er på en indfødt enhed, kan du også synkronisere programmappen med din foretrukne platform. -Google drev har [en officiel app] (https://www.google.com/drive/download/) på vinduer, og der er uofficielle onces i spillebutikken. -På linux kan du også bruge det indfødte fjernlagringssystem og ændre din datamappe til dette eller tilføje en ny ekstern lagring, hvis du klikker på knappen Tilføj forbindelse. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/da/docs/v2/templates.md b/docs/src/content/docs/da/docs/v2/templates.md index bcb9d274ada6..a489c6db3baf 100644 --- a/docs/src/content/docs/da/docs/v2/templates.md +++ b/docs/src/content/docs/da/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Skabeloner In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/da/docs/v2/utilities.md b/docs/src/content/docs/da/docs/v2/utilities.md index 04449c43ec79..2dc2695c11aa 100644 --- a/docs/src/content/docs/da/docs/v2/utilities.md +++ b/docs/src/content/docs/da/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fil -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/da/downloads/web.mdx b/docs/src/content/docs/da/downloads/web.mdx index fe86a6301071..e391577d3535 100644 --- a/docs/src/content/docs/da/downloads/web.mdx +++ b/docs/src/content/docs/da/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/de/community/faq.md b/docs/src/content/docs/de/community/faq.md index 0dfda956b22a..37c5500c31d3 100644 --- a/docs/src/content/docs/de/community/faq.md +++ b/docs/src/content/docs/de/community/faq.md @@ -23,6 +23,8 @@ Versuchen Sie, Ihren Browser auf die neueste Version zu aktualisieren. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Ich benutze die Eingabe des Flutter-Frameworks. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Ich benutze die Eingabe des Flutter-Frameworks. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/de/community/stylus-support.md b/docs/src/content/docs/de/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/de/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/de/docs/v2/add.md b/docs/src/content/docs/de/docs/v2/add.md index d73a4e84a1f2..e0fd59096dd2 100644 --- a/docs/src/content/docs/de/docs/v2/add.md +++ b/docs/src/content/docs/de/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importieren -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Werkzeuge -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/de/docs/v2/collaboration.md b/docs/src/content/docs/de/docs/v2/collaboration.md index 002e9b28bbce..5c64fd0db04a 100644 --- a/docs/src/content/docs/de/docs/v2/collaboration.md +++ b/docs/src/content/docs/de/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. Dies bedeutet, das ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/de/docs/v2/intro.mdx b/docs/src/content/docs/de/docs/v2/intro.mdx index 461ec71fb167..2d06ec9d0f0b 100644 --- a/docs/src/content/docs/de/docs/v2/intro.mdx +++ b/docs/src/content/docs/de/docs/v2/intro.mdx @@ -64,7 +64,7 @@ Um mit der Arbeit an der App zu beginnen, haben Sie zwei Optionen: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Unter diesen finden Sie die Schnellstart-Sektion mit den Vorlagen, die an der aktuellen Stelle verfügbar sind. Für eine neue Installation beinhaltet dies die Vorlagen Hell und Dunkel. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ Um mit der Arbeit an der App zu beginnen, haben Sie zwei Optionen: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Wählen Sie den Anzeigetyp ( Raster oder Liste) - * Reloading the file list + * Reload the file list * Wählen Sie den [Quellspeicher](../storage) der Dateien * Reihenfolge der Dateien sortieren * Füge einen Ordner, Datei, Vorlage oder importiere Dateien hinzu, indem du auf das Plus-Zeichen klickst @@ -102,7 +102,7 @@ Sie können von der Dokumentenansicht mit der Zurück-Taste Ihres Geräts in die * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ Sie können von der Dokumentenansicht mit der Zurück-Taste Ihres Geräts in die * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ Sie können von der Dokumentenansicht mit der Zurück-Taste Ihres Geräts in die * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/de/docs/v2/layers.md b/docs/src/content/docs/de/docs/v2/layers.md index 981f5060fb56..78a63f94ebd0 100644 --- a/docs/src/content/docs/de/docs/v2/layers.md +++ b/docs/src/content/docs/de/docs/v2/layers.md @@ -8,7 +8,7 @@ Die Ebenen werden von unten nach oben gezeichnet, so dass die obere Ebene vor al :::note\[Note] -[Collections](../tools/collection) ist nicht dasselbe wie Ebenen. Sammlungen sind ein leichtgewichtiger Weg, um Elemente zu gruppieren, wirken sich aber nicht auf die Reihenfolge aus, in der sie dargestellt werden. +[Collections](../tools/collection) ist nicht dasselbe wie Ebenen. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/de/docs/v2/pack.md b/docs/src/content/docs/de/docs/v2/pack.md index 30543b326bfd..d97698979b21 100644 --- a/docs/src/content/docs/de/docs/v2/pack.md +++ b/docs/src/content/docs/de/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paket --- -A pack is a collection of components that can be used in the stamp tool. Sie können Ihr eigenes Paket erstellen oder ein bestehendes importieren. Klicken Sie dazu auf die linke obere Ecke und klicken Sie auf "Paket". +A pack is a collection of components that can be used in the stamp tool. Sie können Ihr eigenes Paket erstellen oder ein bestehendes importieren. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Stile @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Paletten -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/de/docs/v2/pages.md b/docs/src/content/docs/de/docs/v2/pages.md index 89b71578a478..141c35a401f1 100644 --- a/docs/src/content/docs/de/docs/v2/pages.md +++ b/docs/src/content/docs/de/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Seiten --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/de/docs/v2/shortcuts.md b/docs/src/content/docs/de/docs/v2/shortcuts.md index cbfe1af92255..66c9cf2dc324 100644 --- a/docs/src/content/docs/de/docs/v2/shortcuts.md +++ b/docs/src/content/docs/de/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Einige davon sind unter den Buttons geschrieben. ## Stift -Standardmäßig ist der Stift so konfiguriert, dass er wie folgt funktioniert: +By default, the pen is configured to function as the following: - `Pen`: als Stift konfiguriert. - `First` (Primärer Knopf, falls unterstützt): Ändern Sie das Handwerkzeug während Sie gedrückt werden. diff --git a/docs/src/content/docs/de/docs/v2/storage.md b/docs/src/content/docs/de/docs/v2/storage.md index f84e593cfe48..f6935d1f1c8c 100644 --- a/docs/src/content/docs/de/docs/v2/storage.md +++ b/docs/src/content/docs/de/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Datenverzeichnis -Das Datenverzeichnis ist das Verzeichnis, in dem Dokumente, Vorlagen und Pakete gespeichert werden. -Auf dem Desktop können Sie es in `~/Documents/Linwood/Butterfly` finden. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Auf dem Handy ist es in `getExternalFilesDir(null)/Linwood/Butterfly`. Sie können es auch in den Einstellungen unter "Data" ändern. @@ -22,7 +22,7 @@ Die Anwendungsdaten werden in Ihrem Browser gespeichert. Es wird in einem lokale ## Native Plattformen -Standardmäßig speichert die Anwendung die Daten in Ihrem Dokumentenordner in einem Unterordner namens "Linwood/Butterfly". Dieser Ordner wird beim Speichern der ersten Daten erstellt. Dieser Ordner kann in den Einstellungen geändert werden. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Dieser Ordner kann in den Einstellungen geändert werden. ## Entfernter Speicher {#remote} @@ -32,12 +32,12 @@ Diese Funktion ist im Web nicht verfügbar. ::: -Die Anwendung kann auf einem entfernten Server gespeichert werden. Dies ist nützlich, wenn Sie die Daten mit anderen Personen teilen möchten oder wenn Sie mehrere Computer haben. Derzeit wird nur das `WebDAV` Protokoll unterstützt. +The application data can be stored on a remote server. Dies ist nützlich, wenn Sie die Daten mit anderen Personen teilen möchten oder wenn Sie mehrere Computer haben. Derzeit wird nur das `WebDAV` Protokoll unterstützt. Um einen entfernten Server hinzuzufügen, gehen Sie zu den Einstellungen und klicken Sie auf `Remotes`. Dann klicken Sie auf `Add remote`. Fügen Sie die URL des entfernten Servers und den Benutzernamen und das Passwort hinzu. Danach können Sie den Ordner angeben, in dem die Daten gespeichert werden. -Um die webdav URL zu erhalten, besuchen Sie bitte die Dokumentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (es sollte so aussehen: `https://nextcloud.example.com/remote.php/dav/files/username/`, ersetzen Sie `username` und `nextcloud.example.com` mit den korrekten Werten) @@ -55,8 +55,8 @@ Es gibt ein paar Einschränkungen: ## Andere Speichermethoden Wenn Sie auf einem nativen Gerät sind, können Sie auch das Anwendungsverzeichnis mit Ihrer Lieblingsplattform synchronisieren. -Google Drive hat [eine offizielle App](https://www.google.com/drive/download/) auf Windows und es gibt inoffizielle Einsendungen im Play Store. -Auf Linux können Sie auch das native Remotespeicher System verwenden und Ihr Datenverzeichnis ändern oder einen neuen externen Speicher hinzufügen, wenn Sie auf die Schaltfläche Verbindung hinzufügen klicken. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/de/docs/v2/templates.md b/docs/src/content/docs/de/docs/v2/templates.md index f397608f97db..278534ec8098 100644 --- a/docs/src/content/docs/de/docs/v2/templates.md +++ b/docs/src/content/docs/de/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Vorlagen In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/de/docs/v2/utilities.md b/docs/src/content/docs/de/docs/v2/utilities.md index e02dcdf4b596..c02b79dcdfd1 100644 --- a/docs/src/content/docs/de/docs/v2/utilities.md +++ b/docs/src/content/docs/de/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Datei -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/de/downloads/web.mdx b/docs/src/content/docs/de/downloads/web.mdx index f903ea5f9191..444615540728 100644 --- a/docs/src/content/docs/de/downloads/web.mdx +++ b/docs/src/content/docs/de/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Dies ist eine progressive Web-Anwendung. Sie können es in Ihrem Browser installieren und offline verwenden. Alle Daten werden in Ihrem Browser gespeichert. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/el/community/faq.md b/docs/src/content/docs/el/community/faq.md index 72e5593f5b78..11b39107ce91 100644 --- a/docs/src/content/docs/el/community/faq.md +++ b/docs/src/content/docs/el/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/el/community/stylus-support.md b/docs/src/content/docs/el/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/el/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/el/docs/v2/add.md b/docs/src/content/docs/el/docs/v2/add.md index 7b23f663718d..f5b81065c06c 100644 --- a/docs/src/content/docs/el/docs/v2/add.md +++ b/docs/src/content/docs/el/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Εισαγωγή -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Εργαλεία -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/el/docs/v2/collaboration.md b/docs/src/content/docs/el/docs/v2/collaboration.md index cd9d73fd0eb0..3d2488f5a15c 100644 --- a/docs/src/content/docs/el/docs/v2/collaboration.md +++ b/docs/src/content/docs/el/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/el/docs/v2/intro.mdx b/docs/src/content/docs/el/docs/v2/intro.mdx index f4353d31f4ec..67f672e5cb02 100644 --- a/docs/src/content/docs/el/docs/v2/intro.mdx +++ b/docs/src/content/docs/el/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/el/docs/v2/layers.md b/docs/src/content/docs/el/docs/v2/layers.md index 40a922854bd3..667ae4071ebb 100644 --- a/docs/src/content/docs/el/docs/v2/layers.md +++ b/docs/src/content/docs/el/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/el/docs/v2/pack.md b/docs/src/content/docs/el/docs/v2/pack.md index 9ecd55101949..01f4fff5f006 100644 --- a/docs/src/content/docs/el/docs/v2/pack.md +++ b/docs/src/content/docs/el/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Πακέτο --- -A pack is a collection of components that can be used in the stamp tool. Μπορείτε να δημιουργήσετε το δικό σας πακέτο ή να εισαγάγετε ένα υπάρχον. Για αυτό κάντε κλικ στην επάνω αριστερή γωνία και κάντε κλικ στο "Packs". +A pack is a collection of components that can be used in the stamp tool. Μπορείτε να δημιουργήσετε το δικό σας πακέτο ή να εισαγάγετε ένα υπάρχον. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/el/docs/v2/pages.md b/docs/src/content/docs/el/docs/v2/pages.md index 85996809408a..9e584513211b 100644 --- a/docs/src/content/docs/el/docs/v2/pages.md +++ b/docs/src/content/docs/el/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Σελίδες --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/el/docs/v2/shortcuts.md b/docs/src/content/docs/el/docs/v2/shortcuts.md index d2d4294bc9ef..1650a69ef703 100644 --- a/docs/src/content/docs/el/docs/v2/shortcuts.md +++ b/docs/src/content/docs/el/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: Συντομεύσεις ## Πένα -Από προεπιλογή, το στυλό έχει ρυθμιστεί ώστε να λειτουργεί ως εξής: +By default, the pen is configured to function as the following: - `Pen`: έχει ρυθμιστεί ως στυλό. - `First` (Πρωτεύον κουμπί, αν υποστηρίζεται): Αλλαγή σε εργαλείο χεριού ενώ πιέζεται. diff --git a/docs/src/content/docs/el/docs/v2/storage.md b/docs/src/content/docs/el/docs/v2/storage.md index 2adf38e52fd2..7589a8404cac 100644 --- a/docs/src/content/docs/el/docs/v2/storage.md +++ b/docs/src/content/docs/el/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Κατάλογος δεδομένων -Ο κατάλογος δεδομένων είναι ο κατάλογος όπου αποθηκεύονται έγγραφα, πρότυπα και πακέτα. -Στην επιφάνεια εργασίας μπορείτε να το βρείτε στο `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Στο κινητό είναι σε `getExternalFilesDir(null)/Linwood/Butterfly`. Μπορείτε επίσης να το αλλάξετε στις ρυθμίσεις στην ενότητα `Data`. @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Εγχώριες πλατφόρμες -Ως προεπιλογή, η εφαρμογή αποθηκεύει τα δεδομένα στο φάκελο εγγράφων σας σε έναν υποφάκελο που ονομάζεται "Linwood/Butterfly". Αυτός ο φάκελος δημιουργείται όταν αποθηκεύετε τα πρώτα δεδομένα. Αυτός ο φάκελος μπορεί να αλλάξει στις ρυθμίσεις. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Αυτός ο φάκελος μπορεί να αλλάξει στις ρυθμίσεις. ## Απομακρυσμένη αποθήκευση {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -Η εφαρμογή μπορεί να αποθηκευτεί σε έναν απομακρυσμένο διακομιστή. Αυτό είναι χρήσιμο αν θέλετε να μοιραστείτε τα δεδομένα με άλλα άτομα ή αν έχετε πολλαπλούς υπολογιστές. Προς το παρόν υποστηρίζεται μόνο το πρωτόκολλο `WebDAV`. +The application data can be stored on a remote server. Αυτό είναι χρήσιμο αν θέλετε να μοιραστείτε τα δεδομένα με άλλα άτομα ή αν έχετε πολλαπλούς υπολογιστές. Προς το παρόν υποστηρίζεται μόνο το πρωτόκολλο `WebDAV`. Για να προσθέσετε έναν απομακρυσμένο διακομιστή, μεταβείτε στις ρυθμίσεις και κάντε κλικ στο κουμπί `Remotes`. Στη συνέχεια, κάντε κλικ στο `Add remote`. Προσθέστε τη διεύθυνση URL του απομακρυσμένου διακομιστή και το όνομα χρήστη και τον κωδικό πρόσβασης. Μετά από αυτό μπορείτε να καθορίσετε το φάκελο όπου αποθηκεύονται τα δεδομένα. -Για να πάρετε το webdav url, επισκεφθείτε την τεκμηρίωση: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (θα πρέπει να μοιάζει κάπως έτσι: `https://nextcloud.example.com/remote.php/dav/files/username/`, αντικαταστήστε το `username` και το `nextcloud.example.com` με τις σωστές τιμές) @@ -55,8 +55,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Άλλες μέθοδοι αποθήκευσης Εάν είστε σε μια εγγενή συσκευή, μπορείτε επίσης να συγχρονίσετε τον κατάλογο εφαρμογών με την αγαπημένη σας πλατφόρμα. -Το Google drive έχει [μια επίσημη εφαρμογή](https://www.google.com/drive/download/) στα παράθυρα και υπάρχουν ανεπίσημες μονάδες στο κατάστημα παιχνιδιού. -Στο linux μπορείτε επίσης να χρησιμοποιήσετε το εγγενές σύστημα απομακρυσμένης αποθήκευσης και να αλλάξετε τον κατάλογο δεδομένων σας σε αυτόν ή να προσθέσετε ένα νέο εξωτερικό χώρο αποθήκευσης αν κάνετε κλικ στο κουμπί προσθήκη. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/el/docs/v2/templates.md b/docs/src/content/docs/el/docs/v2/templates.md index 4d4c4b0874b5..c84ab8911f2b 100644 --- a/docs/src/content/docs/el/docs/v2/templates.md +++ b/docs/src/content/docs/el/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Πρότυπα In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/el/docs/v2/utilities.md b/docs/src/content/docs/el/docs/v2/utilities.md index 81b4b12553ec..c5635381d7e4 100644 --- a/docs/src/content/docs/el/docs/v2/utilities.md +++ b/docs/src/content/docs/el/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Αρχείο -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Κάμερα diff --git a/docs/src/content/docs/el/downloads/web.mdx b/docs/src/content/docs/el/downloads/web.mdx index cc6cb51d99aa..dba8974fb6c7 100644 --- a/docs/src/content/docs/el/downloads/web.mdx +++ b/docs/src/content/docs/el/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Σύνδεσμοι diff --git a/docs/src/content/docs/es/community/faq.md b/docs/src/content/docs/es/community/faq.md index 9029af767ee1..de96ba538488 100644 --- a/docs/src/content/docs/es/community/faq.md +++ b/docs/src/content/docs/es/community/faq.md @@ -23,6 +23,8 @@ Intenta actualizar tu navegador a la última versión. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Estoy usando la entrada proporcionada por el framework de flujos. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Estoy usando la entrada proporcionada por el framework de flujos. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/es/community/stylus-support.md b/docs/src/content/docs/es/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/es/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/es/docs/v2/add.md b/docs/src/content/docs/es/docs/v2/add.md index d56e1a556857..8a98e0aa63e7 100644 --- a/docs/src/content/docs/es/docs/v2/add.md +++ b/docs/src/content/docs/es/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importar -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Herramientas -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/es/docs/v2/collaboration.md b/docs/src/content/docs/es/docs/v2/collaboration.md index d7df44ae82e5..e98be7fc0af0 100644 --- a/docs/src/content/docs/es/docs/v2/collaboration.md +++ b/docs/src/content/docs/es/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/es/docs/v2/intro.mdx b/docs/src/content/docs/es/docs/v2/intro.mdx index a07a48badbd3..b51b25de0aea 100644 --- a/docs/src/content/docs/es/docs/v2/intro.mdx +++ b/docs/src/content/docs/es/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/es/docs/v2/layers.md b/docs/src/content/docs/es/docs/v2/layers.md index f0d55c78685e..8d61c9f59c0a 100644 --- a/docs/src/content/docs/es/docs/v2/layers.md +++ b/docs/src/content/docs/es/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/es/docs/v2/pack.md b/docs/src/content/docs/es/docs/v2/pack.md index 29e65bda7744..1c1c9d924a9f 100644 --- a/docs/src/content/docs/es/docs/v2/pack.md +++ b/docs/src/content/docs/es/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pack --- -A pack is a collection of components that can be used in the stamp tool. Puede crear su propio paquete o importar uno existente. Para ello haga clic en la esquina superior izquierda y haga clic en "Paquetes". +A pack is a collection of components that can be used in the stamp tool. Puede crear su propio paquete o importar uno existente. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/es/docs/v2/pages.md b/docs/src/content/docs/es/docs/v2/pages.md index 075d097a6116..0697a4705e85 100644 --- a/docs/src/content/docs/es/docs/v2/pages.md +++ b/docs/src/content/docs/es/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Páginas --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/es/docs/v2/shortcuts.md b/docs/src/content/docs/es/docs/v2/shortcuts.md index f8534376924c..6a27a8afaca4 100644 --- a/docs/src/content/docs/es/docs/v2/shortcuts.md +++ b/docs/src/content/docs/es/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Algunos de ellos se escriben debajo de los botones. ## Pen -Por defecto, el lápiz está configurado para funcionar de la siguiente manera: +By default, the pen is configured to function as the following: - `Pen`: configurado como pluma. - `Primero` (botón primario, si es soportado): Cambia a la herramienta de mano mientras se presiona. diff --git a/docs/src/content/docs/es/docs/v2/storage.md b/docs/src/content/docs/es/docs/v2/storage.md index 698875d198e2..b3aedd10ab1e 100644 --- a/docs/src/content/docs/es/docs/v2/storage.md +++ b/docs/src/content/docs/es/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Directorio de datos -El directorio de datos es el directorio donde se almacenan documentos, plantillas y paquetes. -En el escritorio lo puedes encontrar en `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. En móvil está en `getExternalFilesDir(null)/Linwood/Butterfly`. También puedes cambiarlo en la configuración bajo `Data`. @@ -22,7 +22,7 @@ Abre las herramientas del desarrollador en tu navegador y verás los datos. ## Plataformas nativas -Por defecto, la aplicación guarda los datos en la carpeta de documentos en una subcarpeta llamada "Linwood/Butterfly". Esta carpeta se crea cuando guarda los primeros datos. Esta carpeta se puede cambiar en la configuración. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Esta carpeta se puede cambiar en la configuración. ## Almacenamiento remoto {#remote} @@ -32,12 +32,12 @@ Esta característica no está disponible en la web. ::: -La aplicación se puede guardar en un servidor remoto. Esto es útil si desea compartir los datos con otras personas o si tiene varios equipos. Actualmente sólo el protocolo `WebDAV` es compatible. +The application data can be stored on a remote server. Esto es útil si desea compartir los datos con otras personas o si tiene varios equipos. Actualmente sólo el protocolo `WebDAV` es compatible. Para añadir un servidor remoto, vaya a la configuración y haga clic en `Remotes`. Luego haga clic en `Agregar remoto`. Añadir la URL del servidor remoto y el nombre de usuario y contraseña. Después, puede especificar la carpeta donde se almacenan los datos. -Para obtener la url webdav, por favor visite la documentación: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/es/files/access_webdav.html) (debería verse así: `https://nextcloud.example.com/remote.php/dav/files/username/`, reemplazar `username` y `nextcloud.example.com` con los valores correctos) @@ -55,8 +55,8 @@ Hay algunas limitaciones: ## Otros métodos de almacenamiento Si estás en un dispositivo nativo, también puedes sincronizar el directorio de aplicaciones con tu plataforma favorita. -Google drive tiene [una aplicación oficial](https://www.google.com/drive/download/) en Windows y hay una vez no oficial en la Play Store. -En linux también puede utilizar el sistema de almacenamiento remoto nativo y cambiar el directorio de datos a éste o añadir un nuevo almacenamiento externo si hace clic en el botón añadir conexión. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/es/docs/v2/templates.md b/docs/src/content/docs/es/docs/v2/templates.md index 2a9611c29852..1b09b11a1828 100644 --- a/docs/src/content/docs/es/docs/v2/templates.md +++ b/docs/src/content/docs/es/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Plantillas In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/es/docs/v2/utilities.md b/docs/src/content/docs/es/docs/v2/utilities.md index fbe9459a53f3..db4f371141ce 100644 --- a/docs/src/content/docs/es/docs/v2/utilities.md +++ b/docs/src/content/docs/es/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fichero -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Cámara diff --git a/docs/src/content/docs/es/downloads/web.mdx b/docs/src/content/docs/es/downloads/web.mdx index a79c21498a72..a38647782ea5 100644 --- a/docs/src/content/docs/es/downloads/web.mdx +++ b/docs/src/content/docs/es/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Esta es una aplicación web progresiva. Puedes instalarlo en tu navegador y usarlo sin conexión. Todos los datos se almacenan en su navegador. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Enlaces diff --git a/docs/src/content/docs/fi/community/faq.md b/docs/src/content/docs/fi/community/faq.md index 518a2a19afd8..2c3acba5ad8e 100644 --- a/docs/src/content/docs/fi/community/faq.md +++ b/docs/src/content/docs/fi/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/fi/community/stylus-support.md b/docs/src/content/docs/fi/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/fi/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/fi/docs/v2/add.md b/docs/src/content/docs/fi/docs/v2/add.md index 00eade9ebffb..04719138b9ae 100644 --- a/docs/src/content/docs/fi/docs/v2/add.md +++ b/docs/src/content/docs/fi/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Tuo -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Työkalut -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/fi/docs/v2/collaboration.md b/docs/src/content/docs/fi/docs/v2/collaboration.md index 9488ff374721..7b4fcb52c9b9 100644 --- a/docs/src/content/docs/fi/docs/v2/collaboration.md +++ b/docs/src/content/docs/fi/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/fi/docs/v2/intro.mdx b/docs/src/content/docs/fi/docs/v2/intro.mdx index 7f8e108be594..073e77ce27a2 100644 --- a/docs/src/content/docs/fi/docs/v2/intro.mdx +++ b/docs/src/content/docs/fi/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/fi/docs/v2/layers.md b/docs/src/content/docs/fi/docs/v2/layers.md index e7c928fa93a1..d71f4b6599a2 100644 --- a/docs/src/content/docs/fi/docs/v2/layers.md +++ b/docs/src/content/docs/fi/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/fi/docs/v2/pack.md b/docs/src/content/docs/fi/docs/v2/pack.md index 3a2719e4b4eb..e94badff0e95 100644 --- a/docs/src/content/docs/fi/docs/v2/pack.md +++ b/docs/src/content/docs/fi/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paketti --- -A pack is a collection of components that can be used in the stamp tool. Voit luoda oman pakettisi tai tuoda olemassa olevan paketin. Tätä varten klikkaa vasemmassa yläkulmassa ja klikkaa "Pakkaukset". +A pack is a collection of components that can be used in the stamp tool. Voit luoda oman pakettisi tai tuoda olemassa olevan paketin. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/fi/docs/v2/pages.md b/docs/src/content/docs/fi/docs/v2/pages.md index 63e23a3028d9..232990f7c2ae 100644 --- a/docs/src/content/docs/fi/docs/v2/pages.md +++ b/docs/src/content/docs/fi/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Sivut --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/fi/docs/v2/shortcuts.md b/docs/src/content/docs/fi/docs/v2/shortcuts.md index 293f2a897fd3..51215bb7e9e0 100644 --- a/docs/src/content/docs/fi/docs/v2/shortcuts.md +++ b/docs/src/content/docs/fi/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Osa niistä on kirjoitettu painikkeiden alle. ## Kynä -Kynä on oletusarvoisesti määritetty toimimaan seuraavasti: +By default, the pen is configured to function as the following: - `Pen`: määritetty kynäksi. - `First` (Valinnainen painike, jos tuettu): Vaihda käsityökalua painettuna. diff --git a/docs/src/content/docs/fi/docs/v2/storage.md b/docs/src/content/docs/fi/docs/v2/storage.md index 29e941ac5226..0e00df861502 100644 --- a/docs/src/content/docs/fi/docs/v2/storage.md +++ b/docs/src/content/docs/fi/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Datakansio -Tietokansio on hakemisto, johon asiakirjoja, malleja ja paketteja tallennetaan. -Työpöydältä löydät sen osoitteesta `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Mobiilissa se on muodossa `getExternalFilesDir(null)/Linwood/Butterfly`. Voit myös muuttaa sitä asetuksissa kohdassa `Data`. @@ -22,7 +22,7 @@ Avaa kehittäjän työkalut selaimessasi ja näet niiden tiedot. ## Natiivi alustat -Oletuksena sovellus tallentaa asiakirjojesi kansiossa olevat tiedot "Linwood/Butterfly" -kansion alikansioon. Tämä kansio on luotu, kun tallennat ensimmäiset tiedot. Tätä kansiota voidaan muuttaa asetuksissa. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Tätä kansiota voidaan muuttaa asetuksissa. ## Etätallennustila {#remote} @@ -32,12 +32,12 @@ Tämä ominaisuus ei ole käytettävissä verkossa. ::: -Sovellus voidaan tallentaa myös etäpalvelimelle. Tämä on hyödyllistä, jos haluat jakaa tietoja muiden ihmisten kanssa tai jos sinulla on useita tietokoneita. Tällä hetkellä vain `WebDAV`-protokolla on tuettu. +The application data can be stored on a remote server. Tämä on hyödyllistä, jos haluat jakaa tietoja muiden ihmisten kanssa tai jos sinulla on useita tietokoneita. Tällä hetkellä vain `WebDAV`-protokolla on tuettu. Jos haluat lisätä etäpalvelimen, siirry asetuksiin ja napsauta `Remotes`. Klikkaa sitten `Add remote`. Lisää etäpalvelimen URL ja käyttäjätunnus ja salasana. Sen jälkeen voit määrittää kansion, jossa tiedot tallennetaan. -Jos haluat saada webdav url, käy dokumentaatio: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (sen pitäisi näyttää tältä: `https://nextcloud.example.com/remote.php/dav/files/username/`, korvaa `username` ja `nextcloud.example.com` oikeilla arvoilla) @@ -55,8 +55,8 @@ On olemassa muutamia rajoituksia: ## Muut varastointimenetelmät Jos olet kotoperäisellä laitteella, voit myös synkronoida sovelluksen hakemiston suosikki alustan. -Google-asemalla on [virallinen sovellus](https://www.google.com/drive/download/) ikkunoissa, ja näytelmäkaupassa on epävirallisia otteita. -Linuxissa voit myös käyttää natiivia etätallennusjärjestelmää ja vaihtaa datahakemiston tähän tai lisätä uuden ulkoisen tallennustilan, jos klikkaat yhteys-painiketta. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/fi/docs/v2/templates.md b/docs/src/content/docs/fi/docs/v2/templates.md index dbf36b1575d5..54621142ce44 100644 --- a/docs/src/content/docs/fi/docs/v2/templates.md +++ b/docs/src/content/docs/fi/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Mallit In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/fi/docs/v2/utilities.md b/docs/src/content/docs/fi/docs/v2/utilities.md index 5f04a08c5ea2..e2744863be9a 100644 --- a/docs/src/content/docs/fi/docs/v2/utilities.md +++ b/docs/src/content/docs/fi/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Tiedosto -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/fi/downloads/web.mdx b/docs/src/content/docs/fi/downloads/web.mdx index 421bd1350549..980b2d796335 100644 --- a/docs/src/content/docs/fi/downloads/web.mdx +++ b/docs/src/content/docs/fi/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Linkit diff --git a/docs/src/content/docs/fr/community/faq.md b/docs/src/content/docs/fr/community/faq.md index 508e3a4a9f36..b0ad2153ddef 100644 --- a/docs/src/content/docs/fr/community/faq.md +++ b/docs/src/content/docs/fr/community/faq.md @@ -23,6 +23,8 @@ Essayez de mettre à jour votre navigateur vers la dernière version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + J'utilise l'entrée fournie par le cadre flutter. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + J'utilise l'entrée fournie par le cadre flutter. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/fr/community/stylus-support.md b/docs/src/content/docs/fr/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/fr/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/fr/docs/v2/add.md b/docs/src/content/docs/fr/docs/v2/add.md index 33fd1f146a0e..79f797165b8b 100644 --- a/docs/src/content/docs/fr/docs/v2/add.md +++ b/docs/src/content/docs/fr/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importation -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Outils -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/fr/docs/v2/collaboration.md b/docs/src/content/docs/fr/docs/v2/collaboration.md index ac93e50ba53f..120d4f2ab4f6 100644 --- a/docs/src/content/docs/fr/docs/v2/collaboration.md +++ b/docs/src/content/docs/fr/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. Cela signifie que ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly utilise un serveur Websocket qui sera hébergé sur votre ordinateur. Ce serveur doit être accessible depuis internet ou depuis votre réseau local. Le client se connectera sur ce serveur. Le serveur synchronise toutes les modifications et tous les événements avec tous les clients. +Butterfly uses a WebSocket server that will be hosted on your computer. Ce serveur doit être accessible depuis internet ou depuis votre réseau local. Le client se connectera sur ce serveur. The server syncs all changes and events with all clients. ### Configuration du serveur @@ -36,9 +36,9 @@ Cette fonctionnalité de serveur n'est pas disponible dans la version web. ::: -Tout d'abord, activez la collaboration expérimentale dans les paramètres. Ensuite, ouvrez le document que vous souhaitez partager. Puis cliquez sur le bouton de partage qui se situe dans l'angle supérieur gauche, à droite du titre. Cela ouvrira une boîte de dialogue. Cliquez sur `Début`. +Tout d'abord, activez la collaboration expérimentale dans les paramètres. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. Cela ouvrira une boîte de dialogue. Cliquez sur `Début`. -Par défaut, le serveur sera hébergé sur toutes les interfaces sur le port `28005`. Vous pouvez changer cela dans la boîte de dialogue. Vous devez vous assurer que ce serveur est accessible au client. +By default, the server will be hosted on all interfaces on port `28005`. Vous pouvez changer cela dans la boîte de dialogue. Vous devez vous assurer que ce serveur est accessible au client. Dans le réseau local, cela devrait fonctionner sans problème. Si vous souhaitez accéder au serveur depuis internet, vous devez rediriger le port sur votre routeur. Vous pouvez trouver plus d'informations à ce sujet [ici](https://fr.wikipedia.org/wiki/Redirection_de_port). Si vous ne pouvez pas rediriger le port, vous pouvez utiliser un service comme [ngrok](https://ngrok.com/). Cela va créer un tunnel vers votre serveur local. C'est utile si vous voulez partager le document avec d'autres personnes. @@ -53,10 +53,10 @@ ngrok http 28005 Vous devez maintenant vous connecter au serveur. Pour ce faire, allez à la page d'accueil et cliquez sur le bouton "plus" comme si vous alliez créer un nouveau document. Là, vous verrez un nouvel élément de menu appelé `Connecter`. -Cliquez dessus et vous verrez une boîte de dialogue. Entrez ici l'url de connexion. -Si vous êtes sur le même réseau, vous pouvez utiliser l'adresse IP locale de l'ordinateur où le serveur fonctionne. -L'URL devrait ressembler à ceci : `ws://{IP}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Cliquez dessus et vous verrez une boîte de dialogue. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/fr/docs/v2/intro.mdx b/docs/src/content/docs/fr/docs/v2/intro.mdx index ddbaea77de80..f7fc183b3996 100644 --- a/docs/src/content/docs/fr/docs/v2/intro.mdx +++ b/docs/src/content/docs/fr/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/fr/docs/v2/layers.md b/docs/src/content/docs/fr/docs/v2/layers.md index f8f14fb0ad3a..57b9690a3233 100644 --- a/docs/src/content/docs/fr/docs/v2/layers.md +++ b/docs/src/content/docs/fr/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/fr/docs/v2/pack.md b/docs/src/content/docs/fr/docs/v2/pack.md index 23213aa0c149..d15f8d048718 100644 --- a/docs/src/content/docs/fr/docs/v2/pack.md +++ b/docs/src/content/docs/fr/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paquet --- -A pack is a collection of components that can be used in the stamp tool. Vous pouvez créer votre propre pack ou importer un pack existant. Pour cela, cliquez sur le coin supérieur gauche et cliquez sur "Packs". +A pack is a collection of components that can be used in the stamp tool. Vous pouvez créer votre propre pack ou importer un pack existant. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/fr/docs/v2/pages.md b/docs/src/content/docs/fr/docs/v2/pages.md index f6430c897736..72e0276b63df 100644 --- a/docs/src/content/docs/fr/docs/v2/pages.md +++ b/docs/src/content/docs/fr/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pages --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/fr/docs/v2/shortcuts.md b/docs/src/content/docs/fr/docs/v2/shortcuts.md index be7bd1d3257a..e2783d7f3a76 100644 --- a/docs/src/content/docs/fr/docs/v2/shortcuts.md +++ b/docs/src/content/docs/fr/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Certaines d'entre elles sont écrites sous les boutons. ## Stylo -Par défaut, le stylo est configuré pour fonctionner comme suit : +By default, the pen is configured to function as the following: - `Stylo`: configuré comme stylo. - `Premier` (Bouton primaire, si supporté) : Changer pour l'outil main pendant qu'il est pressé. diff --git a/docs/src/content/docs/fr/docs/v2/storage.md b/docs/src/content/docs/fr/docs/v2/storage.md index 66117aae4cd4..e761213b2c0f 100644 --- a/docs/src/content/docs/fr/docs/v2/storage.md +++ b/docs/src/content/docs/fr/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Répertoire des données -Le répertoire des données est le répertoire où les documents, les modèles et les packs sont stockés. -Sur le bureau, vous pouvez le trouver dans `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Sur mobile, c'est dans `getExternalFilesDir(null)/Linwood/Butterfly`. Vous pouvez également le modifier dans les paramètres sous `Data`. @@ -22,7 +22,7 @@ Ouvrez les outils de développement dans votre navigateur et vous verrez les don ## Plateformes indigènes -Par défaut, l'application enregistre les données dans votre dossier de documents dans un sous-dossier appelé "Linwood/Butterfly". Ce dossier est créé lorsque vous enregistrez les premières données. Ce dossier peut être modifié dans les paramètres. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Ce dossier peut être modifié dans les paramètres. ## Stockage à distance {#remote} @@ -32,12 +32,12 @@ Cette fonctionnalité n'est pas disponible sur le Web. ::: -L'application peut être enregistrée sur un serveur distant. Ceci est utile si vous voulez partager les données avec d'autres personnes ou si vous avez plusieurs ordinateurs. Actuellement, seul le protocole `WebDAV` est pris en charge. +The application data can be stored on a remote server. Ceci est utile si vous voulez partager les données avec d'autres personnes ou si vous avez plusieurs ordinateurs. Actuellement, seul le protocole `WebDAV` est pris en charge. Pour ajouter un serveur distant, allez dans les paramètres et cliquez sur `Remotes`. Puis cliquez sur `Ajouter une télécommande`. Ajoute l'URL du serveur distant et le nom d'utilisateur et le mot de passe. Ensuite, vous pouvez spécifier le dossier où les données sont stockées. -Pour obtenir l'url webdav, veuillez visiter la documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (il devrait ressembler à ceci: `https://nextcloud.example.com/remote.php/dav/files/username/`, remplacez `username` et `nextcloud.example.com` par les valeurs correctes) @@ -55,8 +55,8 @@ Il y a quelques limitations : ## Autres méthodes de stockage Si vous êtes sur un périphérique natif, vous pouvez également synchroniser le répertoire d'application avec votre plateforme préférée. -Google drive a [une application officielle](https://www.google.com/drive/download/) sur Windows et il y a des fois non officielles sur le Play Store. -Sous Linux, vous pouvez également utiliser le système de stockage natif à distance et changer votre répertoire de données ou ajouter un nouveau stockage externe si vous cliquez sur le bouton d'ajout de connexion. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/fr/docs/v2/templates.md b/docs/src/content/docs/fr/docs/v2/templates.md index 07a60ea17602..c66705d58f3a 100644 --- a/docs/src/content/docs/fr/docs/v2/templates.md +++ b/docs/src/content/docs/fr/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Modèles In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/fr/docs/v2/utilities.md b/docs/src/content/docs/fr/docs/v2/utilities.md index ecbcf125875f..0b23ebfff4e9 100644 --- a/docs/src/content/docs/fr/docs/v2/utilities.md +++ b/docs/src/content/docs/fr/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fichier -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Appareil photo diff --git a/docs/src/content/docs/fr/downloads/web.mdx b/docs/src/content/docs/fr/downloads/web.mdx index 7cb63907a655..bb671e5b3ef8 100644 --- a/docs/src/content/docs/fr/downloads/web.mdx +++ b/docs/src/content/docs/fr/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Ceci est une application web progressive. Vous pouvez l'installer sur votre navigateur et l'utiliser hors ligne. Toutes les données sont stockées dans votre navigateur. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Liens diff --git a/docs/src/content/docs/he/community/faq.md b/docs/src/content/docs/he/community/faq.md index c71b392ff5dd..78fe9541c316 100644 --- a/docs/src/content/docs/he/community/faq.md +++ b/docs/src/content/docs/he/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/he/community/stylus-support.md b/docs/src/content/docs/he/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/he/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/he/docs/v2/add.md b/docs/src/content/docs/he/docs/v2/add.md index 7ab58efaae2f..97eecc2591a1 100644 --- a/docs/src/content/docs/he/docs/v2/add.md +++ b/docs/src/content/docs/he/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## ייבוא -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## כלים -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/he/docs/v2/collaboration.md b/docs/src/content/docs/he/docs/v2/collaboration.md index 07dc68260ff3..58dcd70e8e06 100644 --- a/docs/src/content/docs/he/docs/v2/collaboration.md +++ b/docs/src/content/docs/he/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/he/docs/v2/intro.mdx b/docs/src/content/docs/he/docs/v2/intro.mdx index c639533dfaa5..a513140810bf 100644 --- a/docs/src/content/docs/he/docs/v2/intro.mdx +++ b/docs/src/content/docs/he/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/he/docs/v2/layers.md b/docs/src/content/docs/he/docs/v2/layers.md index a0841879098c..044f81995b16 100644 --- a/docs/src/content/docs/he/docs/v2/layers.md +++ b/docs/src/content/docs/he/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/he/docs/v2/pack.md b/docs/src/content/docs/he/docs/v2/pack.md index b78a70eca809..42ade62dd5a7 100644 --- a/docs/src/content/docs/he/docs/v2/pack.md +++ b/docs/src/content/docs/he/docs/v2/pack.md @@ -2,7 +2,7 @@ title: חבילה --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## סגנונות @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## פלטות צבעים -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/he/docs/v2/pages.md b/docs/src/content/docs/he/docs/v2/pages.md index bf7eb0db7ad1..e8d09fc1ebb2 100644 --- a/docs/src/content/docs/he/docs/v2/pages.md +++ b/docs/src/content/docs/he/docs/v2/pages.md @@ -2,7 +2,7 @@ title: עמודים --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/he/docs/v2/shortcuts.md b/docs/src/content/docs/he/docs/v2/shortcuts.md index f007a3e9629e..13b2de3114a1 100644 --- a/docs/src/content/docs/he/docs/v2/shortcuts.md +++ b/docs/src/content/docs/he/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## עט -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/he/docs/v2/storage.md b/docs/src/content/docs/he/docs/v2/storage.md index 8e6a2cd58757..8e2e54b7e511 100644 --- a/docs/src/content/docs/he/docs/v2/storage.md +++ b/docs/src/content/docs/he/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## ספריית נתונים -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/he/docs/v2/templates.md b/docs/src/content/docs/he/docs/v2/templates.md index e8fdc50dc65d..a2b1028ca395 100644 --- a/docs/src/content/docs/he/docs/v2/templates.md +++ b/docs/src/content/docs/he/docs/v2/templates.md @@ -4,7 +4,7 @@ title: תבניות In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/he/docs/v2/utilities.md b/docs/src/content/docs/he/docs/v2/utilities.md index f8a12de291cb..1872d05588d9 100644 --- a/docs/src/content/docs/he/docs/v2/utilities.md +++ b/docs/src/content/docs/he/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## קובץ -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## מצלמה diff --git a/docs/src/content/docs/he/downloads/web.mdx b/docs/src/content/docs/he/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/he/downloads/web.mdx +++ b/docs/src/content/docs/he/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/hi/community/faq.md b/docs/src/content/docs/hi/community/faq.md index 33698759c157..a03af87b1879 100644 --- a/docs/src/content/docs/hi/community/faq.md +++ b/docs/src/content/docs/hi/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/hi/community/stylus-support.md b/docs/src/content/docs/hi/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/hi/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/hi/docs/v2/add.md b/docs/src/content/docs/hi/docs/v2/add.md index fccd88e861b7..de923df84d96 100644 --- a/docs/src/content/docs/hi/docs/v2/add.md +++ b/docs/src/content/docs/hi/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## आयात करें -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## टूल्स -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/hi/docs/v2/collaboration.md b/docs/src/content/docs/hi/docs/v2/collaboration.md index bf4caf6c45f4..8effcbfa5d81 100644 --- a/docs/src/content/docs/hi/docs/v2/collaboration.md +++ b/docs/src/content/docs/hi/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/hi/docs/v2/intro.mdx b/docs/src/content/docs/hi/docs/v2/intro.mdx index 34df18d5439f..8d697918b2ce 100644 --- a/docs/src/content/docs/hi/docs/v2/intro.mdx +++ b/docs/src/content/docs/hi/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/hi/docs/v2/layers.md b/docs/src/content/docs/hi/docs/v2/layers.md index 78a4e4ac334d..a81f71d69fb9 100644 --- a/docs/src/content/docs/hi/docs/v2/layers.md +++ b/docs/src/content/docs/hi/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/hi/docs/v2/pack.md b/docs/src/content/docs/hi/docs/v2/pack.md index fa908803eff6..90c0ce95e48b 100644 --- a/docs/src/content/docs/hi/docs/v2/pack.md +++ b/docs/src/content/docs/hi/docs/v2/pack.md @@ -2,7 +2,7 @@ title: पैक --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## शैलियाँ @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## पैलेट -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/hi/docs/v2/pages.md b/docs/src/content/docs/hi/docs/v2/pages.md index eaf15767cfcb..c9a4fbdc26c7 100644 --- a/docs/src/content/docs/hi/docs/v2/pages.md +++ b/docs/src/content/docs/hi/docs/v2/pages.md @@ -2,7 +2,7 @@ title: पेज --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/hi/docs/v2/shortcuts.md b/docs/src/content/docs/hi/docs/v2/shortcuts.md index d6491d9e07b8..958ac94df63d 100644 --- a/docs/src/content/docs/hi/docs/v2/shortcuts.md +++ b/docs/src/content/docs/hi/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## पेन -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/hi/docs/v2/storage.md b/docs/src/content/docs/hi/docs/v2/storage.md index 3942249527e8..fac71d24da80 100644 --- a/docs/src/content/docs/hi/docs/v2/storage.md +++ b/docs/src/content/docs/hi/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## डेटा डायरेक्टरी -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/hi/docs/v2/templates.md b/docs/src/content/docs/hi/docs/v2/templates.md index 3917faf17838..06891404c7ef 100644 --- a/docs/src/content/docs/hi/docs/v2/templates.md +++ b/docs/src/content/docs/hi/docs/v2/templates.md @@ -4,7 +4,7 @@ title: टेम्पलेट्स In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/hi/docs/v2/utilities.md b/docs/src/content/docs/hi/docs/v2/utilities.md index e9ad894560b0..5bdb491162ff 100644 --- a/docs/src/content/docs/hi/docs/v2/utilities.md +++ b/docs/src/content/docs/hi/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## फ़ाइल -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## कैमरा diff --git a/docs/src/content/docs/hi/downloads/web.mdx b/docs/src/content/docs/hi/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/hi/downloads/web.mdx +++ b/docs/src/content/docs/hi/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/hu/community/faq.md b/docs/src/content/docs/hu/community/faq.md index 6fae97858295..727c07ed45a4 100644 --- a/docs/src/content/docs/hu/community/faq.md +++ b/docs/src/content/docs/hu/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/hu/community/stylus-support.md b/docs/src/content/docs/hu/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/hu/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/hu/docs/v2/add.md b/docs/src/content/docs/hu/docs/v2/add.md index 1eeb8cf7e548..c1f1f4862bdd 100644 --- a/docs/src/content/docs/hu/docs/v2/add.md +++ b/docs/src/content/docs/hu/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importálás -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Eszközök -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/hu/docs/v2/collaboration.md b/docs/src/content/docs/hu/docs/v2/collaboration.md index 0fdf538b7898..39c69d0752c1 100644 --- a/docs/src/content/docs/hu/docs/v2/collaboration.md +++ b/docs/src/content/docs/hu/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/hu/docs/v2/intro.mdx b/docs/src/content/docs/hu/docs/v2/intro.mdx index 8852fd9a2042..a9d3f5859da5 100644 --- a/docs/src/content/docs/hu/docs/v2/intro.mdx +++ b/docs/src/content/docs/hu/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/hu/docs/v2/layers.md b/docs/src/content/docs/hu/docs/v2/layers.md index bbc083c27e64..a0dbcbf90b89 100644 --- a/docs/src/content/docs/hu/docs/v2/layers.md +++ b/docs/src/content/docs/hu/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/hu/docs/v2/pack.md b/docs/src/content/docs/hu/docs/v2/pack.md index 22e18e17b7e1..dbd53047e990 100644 --- a/docs/src/content/docs/hu/docs/v2/pack.md +++ b/docs/src/content/docs/hu/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Csomag --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Stílusok @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Paletták -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/hu/docs/v2/pages.md b/docs/src/content/docs/hu/docs/v2/pages.md index 80cb04eb7ea5..e85a98caa995 100644 --- a/docs/src/content/docs/hu/docs/v2/pages.md +++ b/docs/src/content/docs/hu/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Oldalak --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/hu/docs/v2/shortcuts.md b/docs/src/content/docs/hu/docs/v2/shortcuts.md index e70262cf9791..c0148aa9b8bb 100644 --- a/docs/src/content/docs/hu/docs/v2/shortcuts.md +++ b/docs/src/content/docs/hu/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Toll -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/hu/docs/v2/storage.md b/docs/src/content/docs/hu/docs/v2/storage.md index fd4acd44027c..004c2153e07a 100644 --- a/docs/src/content/docs/hu/docs/v2/storage.md +++ b/docs/src/content/docs/hu/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Adatmappa -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/hu/docs/v2/templates.md b/docs/src/content/docs/hu/docs/v2/templates.md index b289c8a5dece..05082b3ba27e 100644 --- a/docs/src/content/docs/hu/docs/v2/templates.md +++ b/docs/src/content/docs/hu/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Sablonok In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/hu/docs/v2/utilities.md b/docs/src/content/docs/hu/docs/v2/utilities.md index 2ba63dba2040..e072cc62c2a3 100644 --- a/docs/src/content/docs/hu/docs/v2/utilities.md +++ b/docs/src/content/docs/hu/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fájl -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/hu/downloads/web.mdx b/docs/src/content/docs/hu/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/hu/downloads/web.mdx +++ b/docs/src/content/docs/hu/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/id/community/faq.md b/docs/src/content/docs/id/community/faq.md index c3edf94c3076..ef1eadd22a5e 100644 --- a/docs/src/content/docs/id/community/faq.md +++ b/docs/src/content/docs/id/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/id/community/stylus-support.md b/docs/src/content/docs/id/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/id/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/id/docs/v2/add.md b/docs/src/content/docs/id/docs/v2/add.md index 83db6de184ca..f69dda2dfbde 100644 --- a/docs/src/content/docs/id/docs/v2/add.md +++ b/docs/src/content/docs/id/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Impor -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Tools -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/id/docs/v2/collaboration.md b/docs/src/content/docs/id/docs/v2/collaboration.md index 0b3d35dd75c3..8ca45a99371d 100644 --- a/docs/src/content/docs/id/docs/v2/collaboration.md +++ b/docs/src/content/docs/id/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/id/docs/v2/intro.mdx b/docs/src/content/docs/id/docs/v2/intro.mdx index 4afc88d2f978..782e0dbbcc67 100644 --- a/docs/src/content/docs/id/docs/v2/intro.mdx +++ b/docs/src/content/docs/id/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/id/docs/v2/layers.md b/docs/src/content/docs/id/docs/v2/layers.md index afee888109fa..990cc83d70f4 100644 --- a/docs/src/content/docs/id/docs/v2/layers.md +++ b/docs/src/content/docs/id/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/id/docs/v2/pack.md b/docs/src/content/docs/id/docs/v2/pack.md index d0e1267986f2..2fc7ed426808 100644 --- a/docs/src/content/docs/id/docs/v2/pack.md +++ b/docs/src/content/docs/id/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pack --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/id/docs/v2/pages.md b/docs/src/content/docs/id/docs/v2/pages.md index f6430c897736..72e0276b63df 100644 --- a/docs/src/content/docs/id/docs/v2/pages.md +++ b/docs/src/content/docs/id/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pages --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/id/docs/v2/shortcuts.md b/docs/src/content/docs/id/docs/v2/shortcuts.md index f7b2860935c2..44d2e5ef29d2 100644 --- a/docs/src/content/docs/id/docs/v2/shortcuts.md +++ b/docs/src/content/docs/id/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Pen -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/id/docs/v2/storage.md b/docs/src/content/docs/id/docs/v2/storage.md index 29624e9bd756..ba0b8c2eb918 100644 --- a/docs/src/content/docs/id/docs/v2/storage.md +++ b/docs/src/content/docs/id/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Data directory -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/id/docs/v2/templates.md b/docs/src/content/docs/id/docs/v2/templates.md index 70b56e865c50..034923d50655 100644 --- a/docs/src/content/docs/id/docs/v2/templates.md +++ b/docs/src/content/docs/id/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Templates In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/id/docs/v2/utilities.md b/docs/src/content/docs/id/docs/v2/utilities.md index a06178dfd980..a92539faa66f 100644 --- a/docs/src/content/docs/id/docs/v2/utilities.md +++ b/docs/src/content/docs/id/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Berkas -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Camera diff --git a/docs/src/content/docs/id/downloads/web.mdx b/docs/src/content/docs/id/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/id/downloads/web.mdx +++ b/docs/src/content/docs/id/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/it/community/faq.md b/docs/src/content/docs/it/community/faq.md index 26c86717118c..21a8b73ca2bd 100644 --- a/docs/src/content/docs/it/community/faq.md +++ b/docs/src/content/docs/it/community/faq.md @@ -23,6 +23,8 @@ Prova ad aggiornare il tuo browser all'ultima versione. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Sto usando l'input fornito dal framework flutter. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Sto usando l'input fornito dal framework flutter. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/it/community/stylus-support.md b/docs/src/content/docs/it/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/it/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/it/docs/v2/add.md b/docs/src/content/docs/it/docs/v2/add.md index 1f94951e211d..41ea7d140384 100644 --- a/docs/src/content/docs/it/docs/v2/add.md +++ b/docs/src/content/docs/it/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importa -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Strumenti -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/it/docs/v2/collaboration.md b/docs/src/content/docs/it/docs/v2/collaboration.md index d00da6695194..fbde27f8c881 100644 --- a/docs/src/content/docs/it/docs/v2/collaboration.md +++ b/docs/src/content/docs/it/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/it/docs/v2/intro.mdx b/docs/src/content/docs/it/docs/v2/intro.mdx index 758b74907da4..b78f6930338c 100644 --- a/docs/src/content/docs/it/docs/v2/intro.mdx +++ b/docs/src/content/docs/it/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/it/docs/v2/layers.md b/docs/src/content/docs/it/docs/v2/layers.md index cc997d1f2534..2fb899afa3b9 100644 --- a/docs/src/content/docs/it/docs/v2/layers.md +++ b/docs/src/content/docs/it/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/it/docs/v2/pack.md b/docs/src/content/docs/it/docs/v2/pack.md index c52a7f129d61..ede920fcbfd5 100644 --- a/docs/src/content/docs/it/docs/v2/pack.md +++ b/docs/src/content/docs/it/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pacchetto --- -A pack is a collection of components that can be used in the stamp tool. È possibile creare il proprio pacchetto o importare uno esistente. Per questo cliccare sull'angolo in alto a sinistra e cliccare su "Packs". +A pack is a collection of components that can be used in the stamp tool. È possibile creare il proprio pacchetto o importare uno esistente. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/it/docs/v2/pages.md b/docs/src/content/docs/it/docs/v2/pages.md index d63dae6d89e0..9d04bf2f7ece 100644 --- a/docs/src/content/docs/it/docs/v2/pages.md +++ b/docs/src/content/docs/it/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pagine --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/it/docs/v2/shortcuts.md b/docs/src/content/docs/it/docs/v2/shortcuts.md index e972f2a234ef..0485d7a4a77e 100644 --- a/docs/src/content/docs/it/docs/v2/shortcuts.md +++ b/docs/src/content/docs/it/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Alcuni di loro sono scritti sotto i pulsanti. ## Penna -Per impostazione predefinita, la penna è configurata per funzionare come segue: +By default, the pen is configured to function as the following: - `Penna`: configurato come penna. - `First` (pulsante primario, se supportato): Cambia a mano mentre premuto lo strumento. diff --git a/docs/src/content/docs/it/docs/v2/storage.md b/docs/src/content/docs/it/docs/v2/storage.md index 9dbf15a74697..936c7b994140 100644 --- a/docs/src/content/docs/it/docs/v2/storage.md +++ b/docs/src/content/docs/it/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Cartella dati -Cartella dati -Sul desktop potete trovarlo in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Sul cellulare è in `getExternalFilesDir(null)/Linwood/Butterfly`. Puoi anche modificarlo nelle impostazioni in `Dati`. @@ -22,7 +22,7 @@ Apri gli strumenti di sviluppo nel tuo browser e vedrai i dati. ## Piattaforme native -Come impostazione predefinita, l'applicazione salva i dati nella cartella dei documenti in una sottocartella chiamata "Linwood/Butterfly". Questa cartella viene creata quando si salvano i primi dati. Questa cartella può essere cambiata nelle impostazioni. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Questa cartella può essere cambiata nelle impostazioni. ## Archivio remoto {#remote} @@ -32,12 +32,12 @@ Questa funzione non è disponibile sul web. ::: -L'applicazione può essere salvata in un server remoto. Questo è utile se si desidera condividere i dati con altre persone o se si dispone di più computer. Attualmente è supportato solo il protocollo `WebDAV`. +The application data can be stored on a remote server. Questo è utile se si desidera condividere i dati con altre persone o se si dispone di più computer. Attualmente è supportato solo il protocollo `WebDAV`. Per aggiungere un server remoto, vai alle impostazioni e clicca su `Remotes`. Quindi clicca su `Aggiungi remoto`. Aggiunge l'URL del server remoto e il nome utente e la password. Dopo di che è possibile specificare la cartella in cui vengono memorizzati i dati. -Per ottenere l'url di webdav visita la documentazione: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (dovrebbe assomigliare a questo: `https://nextcloud.example.com/remote.php/dav/files/username/`, sostituisci `username` e `nextcloud.example.com` con i valori corretti) @@ -55,8 +55,8 @@ Ci sono alcune limitazioni: ## Altri metodi di stoccaggio Se sei su un dispositivo nativo puoi anche sincronizzare la directory dell'applicazione con la tua piattaforma preferita. -Google drive ha [un'app ufficiale](https://www.google.com/drive/download/) su Windows e ci sono onces non ufficiali sul play store. -Su linux è anche possibile utilizzare il sistema di archiviazione remota nativo e modificare la directory dei dati in questo o aggiungere una nuova memoria esterna se si fa clic sul pulsante di connessione aggiunta. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/it/docs/v2/templates.md b/docs/src/content/docs/it/docs/v2/templates.md index aa320a1f47cb..cb9dafebfcbc 100644 --- a/docs/src/content/docs/it/docs/v2/templates.md +++ b/docs/src/content/docs/it/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Template In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/it/docs/v2/utilities.md b/docs/src/content/docs/it/docs/v2/utilities.md index fc4d68438e93..b86a06491d9b 100644 --- a/docs/src/content/docs/it/docs/v2/utilities.md +++ b/docs/src/content/docs/it/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## File -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Fotocamera diff --git a/docs/src/content/docs/it/downloads/web.mdx b/docs/src/content/docs/it/downloads/web.mdx index 29ac1391491a..fe1fc6537fc6 100644 --- a/docs/src/content/docs/it/downloads/web.mdx +++ b/docs/src/content/docs/it/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Questa è un'applicazione web progressiva. Puoi installarlo nel tuo browser e usarlo offline. Tutti i dati sono memorizzati nel tuo browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Collegamenti diff --git a/docs/src/content/docs/ja/community/faq.md b/docs/src/content/docs/ja/community/faq.md index 4efade1dbe5f..7dd6847e63a0 100644 --- a/docs/src/content/docs/ja/community/faq.md +++ b/docs/src/content/docs/ja/community/faq.md @@ -23,6 +23,8 @@ title: よく寄せられる質問 > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + フラッターフレームワークで提供される入力を使っています。 This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + フラッターフレームワークで提供される入力を使っています。 There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ja/community/stylus-support.md b/docs/src/content/docs/ja/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ja/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ja/docs/v2/add.md b/docs/src/content/docs/ja/docs/v2/add.md index 651c08190f90..c1f30cec6820 100644 --- a/docs/src/content/docs/ja/docs/v2/add.md +++ b/docs/src/content/docs/ja/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## インポート -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## ツール -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ja/docs/v2/collaboration.md b/docs/src/content/docs/ja/docs/v2/collaboration.md index c8df1c26b3e7..1efc2e32a320 100644 --- a/docs/src/content/docs/ja/docs/v2/collaboration.md +++ b/docs/src/content/docs/ja/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ja/docs/v2/intro.mdx b/docs/src/content/docs/ja/docs/v2/intro.mdx index ad58987ae063..a6b4dfdd9a74 100644 --- a/docs/src/content/docs/ja/docs/v2/intro.mdx +++ b/docs/src/content/docs/ja/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ja/docs/v2/layers.md b/docs/src/content/docs/ja/docs/v2/layers.md index a8ee9c5ea2b9..3ab2744eb9bc 100644 --- a/docs/src/content/docs/ja/docs/v2/layers.md +++ b/docs/src/content/docs/ja/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ja/docs/v2/pack.md b/docs/src/content/docs/ja/docs/v2/pack.md index 844f787be698..03bbefc5403a 100644 --- a/docs/src/content/docs/ja/docs/v2/pack.md +++ b/docs/src/content/docs/ja/docs/v2/pack.md @@ -2,7 +2,7 @@ title: パック --- -A pack is a collection of components that can be used in the stamp tool. 独自のパックを作成したり、既存のパックをインポートすることができます。 このためには、左上隅をクリックし、をクリックします "Packs". +A pack is a collection of components that can be used in the stamp tool. 独自のパックを作成したり、既存のパックをインポートすることができます。 To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ja/docs/v2/pages.md b/docs/src/content/docs/ja/docs/v2/pages.md index bb1542380f76..d5f0ecbc48e2 100644 --- a/docs/src/content/docs/ja/docs/v2/pages.md +++ b/docs/src/content/docs/ja/docs/v2/pages.md @@ -2,7 +2,7 @@ title: ページ --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ja/docs/v2/shortcuts.md b/docs/src/content/docs/ja/docs/v2/shortcuts.md index d1c85c63bc2e..77183e0e9924 100644 --- a/docs/src/content/docs/ja/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ja/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: ショートカット ## ペン -デフォルトでは、ペンは次のように機能するように設定されています。 +By default, the pen is configured to function as the following: - `Pen`: ペンとして設定されています。 - `First` (サポートされている場合はプライマリボタン): 押したまま手動ツールに変更します。 diff --git a/docs/src/content/docs/ja/docs/v2/storage.md b/docs/src/content/docs/ja/docs/v2/storage.md index 324d47450bff..b832ba90a8a6 100644 --- a/docs/src/content/docs/ja/docs/v2/storage.md +++ b/docs/src/content/docs/ja/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## データディレクトリ -データディレクトリは、ドキュメント、テンプレート、パックが格納されているディレクトリです。 -デスクトップでは、`~/Documents/Linwood/Butterfly`で見つけることができます。 +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. モバイルでは、 `getExternalFilesDir(null)/Linwood/Butterfly` にあります。 `Data` の設定で変更することもできます。 @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## ネイティブプラットフォーム -デフォルトでは、アプリケーションはドキュメントフォルダのデータを「Linwood/Butterfly」というサブフォルダに保存します。 このフォルダは、最初のデータを保存するときに作成されます。 このフォルダは設定で変更できます。 +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. このフォルダは設定で変更できます。 ## リモートストレージ {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -アプリケーションはリモートサーバーに保存できます。 これは、データを他の人と共有したい場合や、複数のコンピュータをお持ちの場合に便利です。 現在 `WebDAV` プロトコルのみがサポートされています。 +The application data can be stored on a remote server. これは、データを他の人と共有したい場合や、複数のコンピュータをお持ちの場合に便利です。 現在 `WebDAV` プロトコルのみがサポートされています。 リモートサーバーを追加するには、設定に移動して `Remotes` をクリックします。 `Add remote` をクリックします。 リモートサーバーの URL とユーザー名とパスワードを追加します。 その後、データが格納されているフォルダを指定できます。 -webdav URL を入手するには、以下のドキュメントを参照してください。 +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) （`https://nextcloud.example.com/remote.php/dav/files/username/`、`username` と `nextcloud.example.com` は正しい値に置き換えてください） @@ -55,8 +55,8 @@ webdav URL を入手するには、以下のドキュメントを参照してく ## その他のストレージ方法 ネイティブデバイスを使用している場合は、お気に入りのプラットフォームとアプリケーションディレクトリを同期することもできます。 -Google ドライブは、format@@0(https://www.google.com/drive/download/)をウィンドウに表示しており、Playストアには非公式のアプリがあります。 -Linuxでは、ネイティブのリモートストレージシステムを使用して、データディレクトリをこれに変更したり、接続の追加ボタンをクリックすると新しい外部ストレージを追加することもできます。 +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ja/docs/v2/templates.md b/docs/src/content/docs/ja/docs/v2/templates.md index c7e14af29986..579425d14ac3 100644 --- a/docs/src/content/docs/ja/docs/v2/templates.md +++ b/docs/src/content/docs/ja/docs/v2/templates.md @@ -4,7 +4,7 @@ title: テンプレート In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ja/docs/v2/utilities.md b/docs/src/content/docs/ja/docs/v2/utilities.md index 6c938a66466a..ff36f08e9397 100644 --- a/docs/src/content/docs/ja/docs/v2/utilities.md +++ b/docs/src/content/docs/ja/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## ファイル -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## カメラ diff --git a/docs/src/content/docs/ja/downloads/web.mdx b/docs/src/content/docs/ja/downloads/web.mdx index 38973cacb080..279b28fbd277 100644 --- a/docs/src/content/docs/ja/downloads/web.mdx +++ b/docs/src/content/docs/ja/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; これはプログレッシブウェブアプリケーションです。 ブラウザにインストールしてオフラインで使用できます。 すべてのデータはブラウザに保存されます。 +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## リンク diff --git a/docs/src/content/docs/ko/community/faq.md b/docs/src/content/docs/ko/community/faq.md index 4db76c085403..a879fb54c3d3 100644 --- a/docs/src/content/docs/ko/community/faq.md +++ b/docs/src/content/docs/ko/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ko/community/stylus-support.md b/docs/src/content/docs/ko/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ko/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ko/docs/v2/add.md b/docs/src/content/docs/ko/docs/v2/add.md index c609f3d62e6e..b286e37e315f 100644 --- a/docs/src/content/docs/ko/docs/v2/add.md +++ b/docs/src/content/docs/ko/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## 가져오기 -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## 도구 -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ko/docs/v2/collaboration.md b/docs/src/content/docs/ko/docs/v2/collaboration.md index 7580fbe16e97..aa46d9626645 100644 --- a/docs/src/content/docs/ko/docs/v2/collaboration.md +++ b/docs/src/content/docs/ko/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ko/docs/v2/intro.mdx b/docs/src/content/docs/ko/docs/v2/intro.mdx index bd542df6a6db..b58ae6f801e3 100644 --- a/docs/src/content/docs/ko/docs/v2/intro.mdx +++ b/docs/src/content/docs/ko/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ko/docs/v2/layers.md b/docs/src/content/docs/ko/docs/v2/layers.md index 52cc2ad4f661..5ad498bb69a3 100644 --- a/docs/src/content/docs/ko/docs/v2/layers.md +++ b/docs/src/content/docs/ko/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ko/docs/v2/pack.md b/docs/src/content/docs/ko/docs/v2/pack.md index a9ae79869a85..169901324ed9 100644 --- a/docs/src/content/docs/ko/docs/v2/pack.md +++ b/docs/src/content/docs/ko/docs/v2/pack.md @@ -2,7 +2,7 @@ title: 팩 --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## 스타일 @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## 팔레트 -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ko/docs/v2/pages.md b/docs/src/content/docs/ko/docs/v2/pages.md index 2f44646cd470..37abe779b2c0 100644 --- a/docs/src/content/docs/ko/docs/v2/pages.md +++ b/docs/src/content/docs/ko/docs/v2/pages.md @@ -2,7 +2,7 @@ title: 페이지 --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ko/docs/v2/shortcuts.md b/docs/src/content/docs/ko/docs/v2/shortcuts.md index d42159311afe..6036be78e054 100644 --- a/docs/src/content/docs/ko/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ko/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## 펜 -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/ko/docs/v2/storage.md b/docs/src/content/docs/ko/docs/v2/storage.md index dd4cc84ec67f..b6c7cd85da73 100644 --- a/docs/src/content/docs/ko/docs/v2/storage.md +++ b/docs/src/content/docs/ko/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## 데이터 디렉터리 -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ko/docs/v2/templates.md b/docs/src/content/docs/ko/docs/v2/templates.md index 511f7a21f0f3..3bf94d796de7 100644 --- a/docs/src/content/docs/ko/docs/v2/templates.md +++ b/docs/src/content/docs/ko/docs/v2/templates.md @@ -4,7 +4,7 @@ title: 템플릿 In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ko/docs/v2/utilities.md b/docs/src/content/docs/ko/docs/v2/utilities.md index db4d396bf03a..7a286aec839e 100644 --- a/docs/src/content/docs/ko/docs/v2/utilities.md +++ b/docs/src/content/docs/ko/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## 파일 -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## 카메라 diff --git a/docs/src/content/docs/ko/downloads/web.mdx b/docs/src/content/docs/ko/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/ko/downloads/web.mdx +++ b/docs/src/content/docs/ko/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/nl/community/faq.md b/docs/src/content/docs/nl/community/faq.md index 109bb1b5d588..02b33d61bf63 100644 --- a/docs/src/content/docs/nl/community/faq.md +++ b/docs/src/content/docs/nl/community/faq.md @@ -23,6 +23,8 @@ Probeer uw browser te updaten naar de nieuwste versie. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Ik gebruik de input van het flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Ik gebruik de input van het flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/nl/community/stylus-support.md b/docs/src/content/docs/nl/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/nl/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/nl/docs/v2/add.md b/docs/src/content/docs/nl/docs/v2/add.md index f1ff4a29b7ce..95404f91c20d 100644 --- a/docs/src/content/docs/nl/docs/v2/add.md +++ b/docs/src/content/docs/nl/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importeren -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Hulpmiddelen -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/nl/docs/v2/collaboration.md b/docs/src/content/docs/nl/docs/v2/collaboration.md index b3303e4f02f9..e082a19b820e 100644 --- a/docs/src/content/docs/nl/docs/v2/collaboration.md +++ b/docs/src/content/docs/nl/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/nl/docs/v2/intro.mdx b/docs/src/content/docs/nl/docs/v2/intro.mdx index bc4a9a01aa09..bcda1cdcd436 100644 --- a/docs/src/content/docs/nl/docs/v2/intro.mdx +++ b/docs/src/content/docs/nl/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/nl/docs/v2/layers.md b/docs/src/content/docs/nl/docs/v2/layers.md index 06dc20e2e2e3..0fa16642cdc5 100644 --- a/docs/src/content/docs/nl/docs/v2/layers.md +++ b/docs/src/content/docs/nl/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/nl/docs/v2/pack.md b/docs/src/content/docs/nl/docs/v2/pack.md index 0661b9496f1a..e3de2aa5e8e5 100644 --- a/docs/src/content/docs/nl/docs/v2/pack.md +++ b/docs/src/content/docs/nl/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pakket --- -A pack is a collection of components that can be used in the stamp tool. U kunt uw eigen pakket maken of een bestaande importeren. Klik hiervoor op de linker bovenhoek en klik op "Pakketten". +A pack is a collection of components that can be used in the stamp tool. U kunt uw eigen pakket maken of een bestaande importeren. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/nl/docs/v2/pages.md b/docs/src/content/docs/nl/docs/v2/pages.md index 325da66454f4..df0adea57e95 100644 --- a/docs/src/content/docs/nl/docs/v2/pages.md +++ b/docs/src/content/docs/nl/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pagina's --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/nl/docs/v2/shortcuts.md b/docs/src/content/docs/nl/docs/v2/shortcuts.md index 0fac3b9e39e1..f82120e567c4 100644 --- a/docs/src/content/docs/nl/docs/v2/shortcuts.md +++ b/docs/src/content/docs/nl/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Sommige ervan worden onder de knoppen geschreven. ## pennen -Standaard is de pen geconfigureerd om als volgt te functioneren: +By default, the pen is configured to function as the following: - `Pen`: geconfigureerd als pen. - `Eer` (Primaire knop, indien ondersteund): Verander naar handgereedschap terwijl je wordt ingedrukt. diff --git a/docs/src/content/docs/nl/docs/v2/storage.md b/docs/src/content/docs/nl/docs/v2/storage.md index 3ce0517b5e4d..51bdde210652 100644 --- a/docs/src/content/docs/nl/docs/v2/storage.md +++ b/docs/src/content/docs/nl/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Data map -De gegevensmap is de map waar documenten, sjablonen en pakketten worden opgeslagen. -Op het bureaublad kunt u het vinden in `~/Documenten/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Op mobiel is het in `getExternalFilesDir(null)/Linwood/Butterfly`. U kunt het ook wijzigen in de instellingen onder `Data`. @@ -22,7 +22,7 @@ Open de ontwikkelaarshulpmiddelen in uw browser en u zult de gegevens zien. ## Oorspronkelijke platformen -De applicatie slaat de gegevens op in de map documenten in een submap met de naam "Linwood/Butterfly". Deze map wordt aangemaakt wanneer u de eerste gegevens opslaat. Deze map kan worden gewijzigd in de instellingen. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Deze map kan worden gewijzigd in de instellingen. ## Externe opslag {#remote} @@ -32,12 +32,12 @@ Deze functie is niet beschikbaar op het web. ::: -De applicatie kan worden opgeslagen in een externe server. Dit is handig als je de gegevens wilt delen met andere mensen of als je meerdere computers hebt. Momenteel wordt alleen het `WebDAV` protocol ondersteund. +The application data can be stored on a remote server. Dit is handig als je de gegevens wilt delen met andere mensen of als je meerdere computers hebt. Momenteel wordt alleen het `WebDAV` protocol ondersteund. Om een externe server toe te voegen, ga naar instellingen en klik op `Remotes`. Klik vervolgens op `Voeg remote` toe. Klik vervolgens op `Voeg remote` toe. Voeg de URL van de externe server en de gebruikersnaam en het wachtwoord toe. Daarna kunt u de map opgeven waar de gegevens worden opgeslagen. -Om de webdav url te krijgen, bezoek de documentatie: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (het zou er zo uit moeten zien: `https://nextcloud.example.com/remote.php/dav/files/username/`, vervang `username` en `nextcloud.example.com` door de juiste waarden) @@ -55,8 +55,8 @@ Er zijn enkele beperkingen: ## Andere opslagmethoden Als je op een native apparaat bent, kun je ook de applicatiemap synchroniseren met je favoriete platform. -Google drive heeft [een officiële app](https://www.google.com/drive/download/) op windows en er zijn onofficiële onces in de play store. -Op linux kun je ook het native externe opslagsysteem gebruiken en je gegevensmap hierin wijzigen of een nieuwe externe opslag toevoegen als je op de verbindingsknop klikt. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/nl/docs/v2/templates.md b/docs/src/content/docs/nl/docs/v2/templates.md index f822a9221f50..5bdd5d7aca95 100644 --- a/docs/src/content/docs/nl/docs/v2/templates.md +++ b/docs/src/content/docs/nl/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Sjablonen In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/nl/docs/v2/utilities.md b/docs/src/content/docs/nl/docs/v2/utilities.md index 705e4f53443e..3b6d8373d0f5 100644 --- a/docs/src/content/docs/nl/docs/v2/utilities.md +++ b/docs/src/content/docs/nl/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Bestand -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## camera diff --git a/docs/src/content/docs/nl/downloads/web.mdx b/docs/src/content/docs/nl/downloads/web.mdx index 92c555a3f4e4..e6f9d0f5328f 100644 --- a/docs/src/content/docs/nl/downloads/web.mdx +++ b/docs/src/content/docs/nl/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Dit is een progressieve webapplicatie. U kunt deze installeren in uw browser en deze offline gebruiken. Alle gegevens worden opgeslagen in uw browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Koppelingen diff --git a/docs/src/content/docs/no/community/faq.md b/docs/src/content/docs/no/community/faq.md index 5ee9420ca739..ebef1170f9ce 100644 --- a/docs/src/content/docs/no/community/faq.md +++ b/docs/src/content/docs/no/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/no/community/stylus-support.md b/docs/src/content/docs/no/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/no/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/no/docs/v2/add.md b/docs/src/content/docs/no/docs/v2/add.md index cafd88db2796..0571d93eb85e 100644 --- a/docs/src/content/docs/no/docs/v2/add.md +++ b/docs/src/content/docs/no/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importer -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Verktøy -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/no/docs/v2/collaboration.md b/docs/src/content/docs/no/docs/v2/collaboration.md index 96fd241c0df8..25395638e2b0 100644 --- a/docs/src/content/docs/no/docs/v2/collaboration.md +++ b/docs/src/content/docs/no/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/no/docs/v2/intro.mdx b/docs/src/content/docs/no/docs/v2/intro.mdx index 0d3346ef9c7f..d57c1a698aed 100644 --- a/docs/src/content/docs/no/docs/v2/intro.mdx +++ b/docs/src/content/docs/no/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/no/docs/v2/layers.md b/docs/src/content/docs/no/docs/v2/layers.md index e645e38949ce..c50a7ed90469 100644 --- a/docs/src/content/docs/no/docs/v2/layers.md +++ b/docs/src/content/docs/no/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/no/docs/v2/pack.md b/docs/src/content/docs/no/docs/v2/pack.md index c7471dfd72a8..11023f8cb653 100644 --- a/docs/src/content/docs/no/docs/v2/pack.md +++ b/docs/src/content/docs/no/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pakke --- -A pack is a collection of components that can be used in the stamp tool. Du kan lage din egen pakke eller importere en eksisterende pakke. For dette klikk i øvre venstre hjørne og klikk på "Flakker". +A pack is a collection of components that can be used in the stamp tool. Du kan lage din egen pakke eller importere en eksisterende pakke. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/no/docs/v2/pages.md b/docs/src/content/docs/no/docs/v2/pages.md index 1d1a44ef2abc..39ee58771c1f 100644 --- a/docs/src/content/docs/no/docs/v2/pages.md +++ b/docs/src/content/docs/no/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Sider --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/no/docs/v2/shortcuts.md b/docs/src/content/docs/no/docs/v2/shortcuts.md index b1541a02fa17..2a043990341d 100644 --- a/docs/src/content/docs/no/docs/v2/shortcuts.md +++ b/docs/src/content/docs/no/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Noen av dem er skrevet under knappene. ## Penn -Som standard konfigureres pennen til å fungere som følgende: +By default, the pen is configured to function as the following: - En penn: konfigurert som penn. - `Først` (Primærknapp, hvis støttet): Bytt til håndverktøy mens du trykker. diff --git a/docs/src/content/docs/no/docs/v2/storage.md b/docs/src/content/docs/no/docs/v2/storage.md index 102bb916afc4..301d73146034 100644 --- a/docs/src/content/docs/no/docs/v2/storage.md +++ b/docs/src/content/docs/no/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Datamaskin katalog -Datatalogen er mappen hvor dokumenter, maler og pakker lagres. -På skrivebordet finner du den i `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. På mobilen er den i `getExternalFilesDir(null)/Linwood/Butterfly`. Du kan også endre det i innstillingene under "Data". @@ -22,7 +22,7 @@ Applikasjonsdata er lagret i nettleseren din. Det oppbevares i lokal lagring. ## Native plattformer -Som standard lagrer programmet data i dokumentmappen i en undermappe kalt "Linwood/Butterfly". Denne mappen blir opprettet når du lagrer de første dataene. Denne mappen kan endres i innstillingene. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Denne mappen kan endres i innstillingene. ## Ekstern lagring {#remote} @@ -32,12 +32,12 @@ Denne funksjonen er ikke tilgjengelig på nettet. ::: -Programmet kan lagres på en ekstern server. Dette er nyttig hvis du vil dele dataene med andre personer, eller hvis du har flere datamaskiner. For øyeblikket støttes bare `WebDAV`-protokollen. +The application data can be stored on a remote server. Dette er nyttig hvis du vil dele dataene med andre personer, eller hvis du har flere datamaskiner. For øyeblikket støttes bare `WebDAV`-protokollen. For å legge til en ekstern server, gå til innstillingene og klikk på `fjernkontroller`. Klikk deretter på `Legg til fjernkontroll`. Legg til URL-adressen for den eksterne serveren og brukernavnet og passordet. Deretter kan du spesifisere mappen hvor dataene er lagret. -For å få nettadressen, vennligst besøk dokumentasjonen: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (det skal se ut slik: `https://nextcloud.example.com/remote.php/dav/files/username/`, erstatt `username` og `nextcloud.example.com` med de riktige verdiene) @@ -55,8 +55,8 @@ Det finnes noen begrensninger: ## Andre lagringsmetoder Hvis du er på en innebygd enhet, kan du også synkronisere programkatalogen med favorittplattformen din. -Google drive har en offisiell app](https://www.google.com/drive/download/) på vinduer og det er uoffisielle onces i spillbutikken. -På linux kan du også bruke det innebygde fjernlagringssystemet og endre datamappen din til denne eller legge til en ny ekstern lagring hvis du klikker på knappen Legg til tilkobling. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### Svg This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/no/docs/v2/templates.md b/docs/src/content/docs/no/docs/v2/templates.md index 3c8828399457..cb9c65fe3373 100644 --- a/docs/src/content/docs/no/docs/v2/templates.md +++ b/docs/src/content/docs/no/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Maler In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/no/docs/v2/utilities.md b/docs/src/content/docs/no/docs/v2/utilities.md index 04449c43ec79..2dc2695c11aa 100644 --- a/docs/src/content/docs/no/docs/v2/utilities.md +++ b/docs/src/content/docs/no/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fil -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/no/downloads/web.mdx b/docs/src/content/docs/no/downloads/web.mdx index 0eb3fd0f9e07..ff3c950a73b9 100644 --- a/docs/src/content/docs/no/downloads/web.mdx +++ b/docs/src/content/docs/no/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Lenker diff --git a/docs/src/content/docs/or/community/faq.md b/docs/src/content/docs/or/community/faq.md index a36c30b7202a..18d45aad22a3 100644 --- a/docs/src/content/docs/or/community/faq.md +++ b/docs/src/content/docs/or/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/or/community/stylus-support.md b/docs/src/content/docs/or/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/or/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/or/docs/v2/add.md b/docs/src/content/docs/or/docs/v2/add.md index 2ddffe63fc34..1951dd76e062 100644 --- a/docs/src/content/docs/or/docs/v2/add.md +++ b/docs/src/content/docs/or/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## ଆମଦାନି -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## ଟୁଲ୍ -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/or/docs/v2/collaboration.md b/docs/src/content/docs/or/docs/v2/collaboration.md index 9376b2ec39ad..a462e6378501 100644 --- a/docs/src/content/docs/or/docs/v2/collaboration.md +++ b/docs/src/content/docs/or/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/or/docs/v2/intro.mdx b/docs/src/content/docs/or/docs/v2/intro.mdx index 64907fd6c1d9..5c1d9570863f 100644 --- a/docs/src/content/docs/or/docs/v2/intro.mdx +++ b/docs/src/content/docs/or/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/or/docs/v2/layers.md b/docs/src/content/docs/or/docs/v2/layers.md index c37664aba717..f4b0c854c206 100644 --- a/docs/src/content/docs/or/docs/v2/layers.md +++ b/docs/src/content/docs/or/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/or/docs/v2/pack.md b/docs/src/content/docs/or/docs/v2/pack.md index 84834ced54ec..e8e948200090 100644 --- a/docs/src/content/docs/or/docs/v2/pack.md +++ b/docs/src/content/docs/or/docs/v2/pack.md @@ -2,7 +2,7 @@ title: ପ୍ୟାକ୍ --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## ଶୈଳୀ @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## ପ୍ୟାଲେଟ୍ -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/or/docs/v2/pages.md b/docs/src/content/docs/or/docs/v2/pages.md index 8f8db38bfceb..127cfe9e655a 100644 --- a/docs/src/content/docs/or/docs/v2/pages.md +++ b/docs/src/content/docs/or/docs/v2/pages.md @@ -2,7 +2,7 @@ title: ପୃଷ୍ଠାଗୁଡିକ --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/or/docs/v2/shortcuts.md b/docs/src/content/docs/or/docs/v2/shortcuts.md index a503a3aa4668..a46dc00d6b76 100644 --- a/docs/src/content/docs/or/docs/v2/shortcuts.md +++ b/docs/src/content/docs/or/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## କଲମ -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/or/docs/v2/storage.md b/docs/src/content/docs/or/docs/v2/storage.md index 5b04000a461b..4fc5af3961cd 100644 --- a/docs/src/content/docs/or/docs/v2/storage.md +++ b/docs/src/content/docs/or/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## ଡାଟା ଡିରେକ୍ଟୋରି -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/or/docs/v2/templates.md b/docs/src/content/docs/or/docs/v2/templates.md index 63ac008d484a..6fc68cc638af 100644 --- a/docs/src/content/docs/or/docs/v2/templates.md +++ b/docs/src/content/docs/or/docs/v2/templates.md @@ -4,7 +4,7 @@ title: ଟେମ୍ପଲେଟ୍ In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/or/docs/v2/utilities.md b/docs/src/content/docs/or/docs/v2/utilities.md index 33f040d8b5f8..3324e29100bd 100644 --- a/docs/src/content/docs/or/docs/v2/utilities.md +++ b/docs/src/content/docs/or/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## ଫାଇଲ୍ -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## କ୍ୟାମେରା diff --git a/docs/src/content/docs/or/downloads/web.mdx b/docs/src/content/docs/or/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/or/downloads/web.mdx +++ b/docs/src/content/docs/or/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/pl/community/faq.md b/docs/src/content/docs/pl/community/faq.md index ca209a5fa10f..c71516b67b8e 100644 --- a/docs/src/content/docs/pl/community/faq.md +++ b/docs/src/content/docs/pl/community/faq.md @@ -23,6 +23,8 @@ Spróbuj zaktualizować przeglądarkę do najnowszej wersji. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Używam danych wejściowych dostarczanych przez ramę wytrząsania. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Używam danych wejściowych dostarczanych przez ramę wytrząsania. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/pl/community/stylus-support.md b/docs/src/content/docs/pl/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/pl/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/pl/docs/v2/add.md b/docs/src/content/docs/pl/docs/v2/add.md index 58d5dcf88d1d..254364899bd9 100644 --- a/docs/src/content/docs/pl/docs/v2/add.md +++ b/docs/src/content/docs/pl/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importuj -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Narzędzia -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/pl/docs/v2/collaboration.md b/docs/src/content/docs/pl/docs/v2/collaboration.md index f806fde2907d..e5276bdb8931 100644 --- a/docs/src/content/docs/pl/docs/v2/collaboration.md +++ b/docs/src/content/docs/pl/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/pl/docs/v2/intro.mdx b/docs/src/content/docs/pl/docs/v2/intro.mdx index 58b35ec2545c..616d3ecfc8c5 100644 --- a/docs/src/content/docs/pl/docs/v2/intro.mdx +++ b/docs/src/content/docs/pl/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/pl/docs/v2/layers.md b/docs/src/content/docs/pl/docs/v2/layers.md index 9d24eaeb2d9b..ba222f3c42c8 100644 --- a/docs/src/content/docs/pl/docs/v2/layers.md +++ b/docs/src/content/docs/pl/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/pl/docs/v2/pack.md b/docs/src/content/docs/pl/docs/v2/pack.md index 3e904425de20..9bae2f501756 100644 --- a/docs/src/content/docs/pl/docs/v2/pack.md +++ b/docs/src/content/docs/pl/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paczka --- -A pack is a collection of components that can be used in the stamp tool. Możesz utworzyć własny pakiet lub zaimportować istniejący. Aby kliknąć w lewym górnym rogu i kliknij na "Paczki". +A pack is a collection of components that can be used in the stamp tool. Możesz utworzyć własny pakiet lub zaimportować istniejący. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/pl/docs/v2/pages.md b/docs/src/content/docs/pl/docs/v2/pages.md index 198014eb5283..ba5a2437d31d 100644 --- a/docs/src/content/docs/pl/docs/v2/pages.md +++ b/docs/src/content/docs/pl/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Strony --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/pl/docs/v2/shortcuts.md b/docs/src/content/docs/pl/docs/v2/shortcuts.md index 8c696e2c8b19..cd75ed18a9b2 100644 --- a/docs/src/content/docs/pl/docs/v2/shortcuts.md +++ b/docs/src/content/docs/pl/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Niektóre z nich są napisane pod przyciskami. ## Długopis -Domyślnie wstrzykiwacz jest skonfigurowany do następujących funkcji: +By default, the pen is configured to function as the following: - `Pióro`: skonfigurowany jako długopis. - `First` (główny przycisk, jeśli jest obsługiwany): Zmień na narzędzie ręczne po naciśnięciu. diff --git a/docs/src/content/docs/pl/docs/v2/storage.md b/docs/src/content/docs/pl/docs/v2/storage.md index 22103b24b40f..33f72d1e9295 100644 --- a/docs/src/content/docs/pl/docs/v2/storage.md +++ b/docs/src/content/docs/pl/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Katalog danych -Katalog danych jest katalogiem, w którym przechowywane są dokumenty, szablony i paczki. -Na pulpicie możesz go znaleźć w `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Na urządzeniu mobilnym znajduje się w `getExternalFilesDir(null)/Linwood/Butterfly`. Możesz to również zmienić w ustawieniach w `Data`. @@ -22,7 +22,7 @@ Otwórz narzędzia deweloperskie w przeglądarce i zobaczysz dane. ## Platformy rodzime -Domyślnie aplikacja zapisuje dane w folderze dokumentów w podfolderze o nazwie "Linwood/Butterfly". Ten folder jest tworzony podczas zapisywania pierwszych danych. Ten folder może zostać zmieniony w ustawieniach. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Ten folder może zostać zmieniony w ustawieniach. ## Zdalna pamięć {#remote} @@ -32,12 +32,12 @@ Ta funkcja nie jest dostępna w sieci. ::: -Aplikacja może być zapisana na zdalnym serwerze. Jest to przydatne, jeśli chcesz udostępnić dane innym osobom lub jeśli masz wiele komputerów. Obecnie obsługiwany jest tylko protokół `WebDAV`. +The application data can be stored on a remote server. Jest to przydatne, jeśli chcesz udostępnić dane innym osobom lub jeśli masz wiele komputerów. Obecnie obsługiwany jest tylko protokół `WebDAV`. Aby dodać zdalny serwer, przejdź do ustawień i kliknij na `Remotes`. Następnie kliknij na `Dodaj zdalne`. Dodaj adres URL zdalnego serwera oraz nazwę użytkownika i hasło. Następnie możesz określić folder, w którym przechowywane są dane. -Aby uzyskać adres URL webdava, odwiedź dokumentację: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (powinien wyglądać tak: `https://nextcloud.example.com/remote.php/dav/files/username/`, zamiana `username` i `nextcloud.example.com` na prawidłowe wartości) @@ -55,8 +55,8 @@ Istnieje kilka ograniczeń: ## Inne metody przechowywania Jeśli jesteś na natywnym urządzeniu, możesz również zsynchronizować katalog aplikacji z ulubioną platformą. -Dysk Google ma [oficjalną aplikację](https://www.google.com/drive/download/) na oknie i w sklepie odtwarzania są nieoficjalne. -Na Linux możesz również użyć natywnego zdalnego systemu przechowywania danych i zmienić katalog na ten lub dodać nową pamięć zewnętrzną, jeśli klikniesz przycisk Dodaj połączenie. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/pl/docs/v2/templates.md b/docs/src/content/docs/pl/docs/v2/templates.md index badc5ee59246..b96881caf063 100644 --- a/docs/src/content/docs/pl/docs/v2/templates.md +++ b/docs/src/content/docs/pl/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Szablony In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/pl/docs/v2/utilities.md b/docs/src/content/docs/pl/docs/v2/utilities.md index 748be8ab9375..25a3f80d418e 100644 --- a/docs/src/content/docs/pl/docs/v2/utilities.md +++ b/docs/src/content/docs/pl/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Plik -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Aparat diff --git a/docs/src/content/docs/pl/downloads/web.mdx b/docs/src/content/docs/pl/downloads/web.mdx index 7115545364e0..2265a1570cf0 100644 --- a/docs/src/content/docs/pl/downloads/web.mdx +++ b/docs/src/content/docs/pl/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Jest to postępowa aplikacja internetowa. Możesz go zainstalować w przeglądarce i używać w trybie offline. Wszystkie dane są przechowywane w przeglądarce. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Linki diff --git a/docs/src/content/docs/pt-br/community/faq.md b/docs/src/content/docs/pt-br/community/faq.md index 0600cec58557..ef9ce4fdf959 100644 --- a/docs/src/content/docs/pt-br/community/faq.md +++ b/docs/src/content/docs/pt-br/community/faq.md @@ -19,38 +19,40 @@ Tente atualizar seu navegador para a versão mais recente. ## Celular -### S-Pen won't be recognized +### S-Pen não vai ser reconhecida > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Eu estou usando os dados fornecidos pelo framework de agitação. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). -### Butterfly is slow +### Butterfly é lento -Butterfly is optimized every update, but sometimes the problem could be from your device. +Butterfly é otimizado em todas as atualizações, mas algumas vezes possa ser um problema do seu dispositivo -1. First, turn off your device's power saver mode. -2. Then, set your screen refresh rate to its highest available (if supported by your device) +1. Primeiro, desative a economia de bateria do seu dispositivo. +2. Então, defina a taxa de atualização de tela para a maior possível (se houver suporte) -This allows Butterfly to refresh faster and feel more responsive. +Isso permite que o Butterfly atualize mais rapidamente e pareça mais responsivo. -If these steps dont help, please dont hesitate to complain in Discord, Matrix, or in Github. +Se esses passos não ajudarem, por favor, não hesite em reclamar no Discord, Matrix ou no Github. -### Butterfly restarts in the background +### Buterfly reinicia em segundo plano -Disable battery optimization for Butterfly. -Battery optimizations prevent apps from running normally in the background to save power. +Desative a otimização de bateria para o Butterfly +Otimizações de bateria impedem que apps sejam executados normalmente em segundo plano para economizar energia. -Samsung, among other brands, usually put heavy battery restrictions on apps that crash frequently or overheat the device. +Samsung, entre outras marcas, geralmente colocam grandes restrições de bateria em apps que travam com frequência ou superaquecem o dispositivo. -If you dont know how to disable battery optimization for Butterfly, this website may help: [Dont kill my app!](https://dontkillmyapp.com/) +Se você não souber como desativar a otimização de bateria para o Butterfly, este site pode ajudar: [Não mate meu aplicativo!](https://dontkillmyapp.com/) -### iOS support +### Suporte para iOS > [#244](https://github.com/LinwoodDev/Butterfly/issues/244) -Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood.dev/downloads/ios) to download it. See [here](https://github.com/LinwoodDev/Butterfly/issues/244#issuecomment-1935460878) why it's not available on the App Store. +O Buttefly está disponível no iOS como prévia. Click [here](https://butterfly.linwood.dev/downloads/ios) to download it. See [here](https://github.com/LinwoodDev/Butterfly/issues/244#issuecomment-1935460878) why it's not available on the App Store. ## Computadores @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Eu estou usando os dados fornecidos pelo framework de agitação. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/pt-br/community/stylus-support.md b/docs/src/content/docs/pt-br/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/pt-br/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/pt-br/docs/v2/add.md b/docs/src/content/docs/pt-br/docs/v2/add.md index 7ecbd5675219..f9ee1cd3e01c 100644 --- a/docs/src/content/docs/pt-br/docs/v2/add.md +++ b/docs/src/content/docs/pt-br/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importação -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Ferramentas -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Leia mais sobre eles [aqui](../tools). ## Surfaces diff --git a/docs/src/content/docs/pt-br/docs/v2/collaboration.md b/docs/src/content/docs/pt-br/docs/v2/collaboration.md index d6b8eaafae8c..9c6b1dc3d5e6 100644 --- a/docs/src/content/docs/pt-br/docs/v2/collaboration.md +++ b/docs/src/content/docs/pt-br/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/pt-br/docs/v2/intro.mdx b/docs/src/content/docs/pt-br/docs/v2/intro.mdx index a688d9b5fe78..59064cfff5d4 100644 --- a/docs/src/content/docs/pt-br/docs/v2/intro.mdx +++ b/docs/src/content/docs/pt-br/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/pt-br/docs/v2/layers.md b/docs/src/content/docs/pt-br/docs/v2/layers.md index 09e5655415a8..305a6d8c3778 100644 --- a/docs/src/content/docs/pt-br/docs/v2/layers.md +++ b/docs/src/content/docs/pt-br/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/pt-br/docs/v2/pack.md b/docs/src/content/docs/pt-br/docs/v2/pack.md index fb4b4c9555c0..f9bb1c4d518f 100644 --- a/docs/src/content/docs/pt-br/docs/v2/pack.md +++ b/docs/src/content/docs/pt-br/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pacote --- -Um pacote é uma coleção de componentes que podem ser usados na ferramenta de selos. Você pode criar seu próprio pacote ou importar um existente. Para este clique no canto superior esquerdo e clique em "Pacotes". +Um pacote é uma coleção de componentes que podem ser usados na ferramenta de selos. Você pode criar seu próprio pacote ou importar um existente. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/pt-br/docs/v2/pages.md b/docs/src/content/docs/pt-br/docs/v2/pages.md index 075d097a6116..0697a4705e85 100644 --- a/docs/src/content/docs/pt-br/docs/v2/pages.md +++ b/docs/src/content/docs/pt-br/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Páginas --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/pt-br/docs/v2/shortcuts.md b/docs/src/content/docs/pt-br/docs/v2/shortcuts.md index 272ad2ab40e1..bc663480e7f4 100644 --- a/docs/src/content/docs/pt-br/docs/v2/shortcuts.md +++ b/docs/src/content/docs/pt-br/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Alguns deles estão escritos abaixo dos botões. ## Caneta -Por padrão, a caneta está configurada para funcionar como o seguinte: +By default, the pen is configured to function as the following: - `Pen`: configurado como caneta. - `Primeiro` (botão principal, se suportado): Mude a ferramenta enquanto pressionado. diff --git a/docs/src/content/docs/pt-br/docs/v2/storage.md b/docs/src/content/docs/pt-br/docs/v2/storage.md index 28e0e83de390..5f9683ca710a 100644 --- a/docs/src/content/docs/pt-br/docs/v2/storage.md +++ b/docs/src/content/docs/pt-br/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Diretório de dados -O diretório de dados é o diretório onde documentos, modelos e pacotes são armazenados. -Na área de trabalho você pode encontrá-la em `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. No dispositivo móvel está em `getExternalFilesDir(null)/Linwood/Butterfly`. Você também pode alterá-lo nas configurações em `Data`. @@ -22,7 +22,7 @@ Abra as ferramentas de desenvolvedor no seu navegador e você verá os dados. ## Plataformas nativas -Como padrão, a aplicação salva os dados na pasta de documentos em uma subpasta chamada "Linwood/Butterfly". Esta pasta é criada quando você salva os primeiros dados. Esta pasta pode ser alterada nas configurações. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Esta pasta pode ser alterada nas configurações. ## Armazenamento remoto {#remote} @@ -32,12 +32,12 @@ Este recurso não está disponível na web. ::: -O aplicativo pode ser salvo em um servidor remoto. Isso é útil se você quiser compartilhar os dados com outras pessoas ou se você tiver vários computadores. Atualmente, apenas o protocolo `WebDAV` é suportado. +The application data can be stored on a remote server. Isso é útil se você quiser compartilhar os dados com outras pessoas ou se você tiver vários computadores. Atualmente, apenas o protocolo `WebDAV` é suportado. Para adicionar um servidor remoto, vá para as configurações e clique em `Remotes`. Em seguida, clique em 'Adicionar remoto'. Adicione a URL do servidor remoto e o nome de usuário e senha. Depois disso, você pode especificar a pasta onde os dados são armazenados. -Para obter o URL do webdav, por favor, visite a documentação: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (deve se parecer com isto: `https://nextcloud.example.com/remote.php/dav/files/username/`, substitua `username` e `nextcloud.example.com` com os valores corretos) @@ -55,8 +55,8 @@ Existem algumas limitações: ## Outros métodos de armazenamento Se você está em um dispositivo nativo, também pode sincronizar o diretório do aplicativo com a sua plataforma favorita. -O Google drive possui [um aplicativo oficial](https://www.google.com/drive/download/) nas janelas e há ondas não oficiais na Play Store. -No Linux, você também pode usar o sistema de armazenamento remoto nativo e alterar o diretório de dados para isto ou adicionar um novo armazenamento externo se você clicar no botão adicionar conexão. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### Svg This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/pt-br/docs/v2/templates.md b/docs/src/content/docs/pt-br/docs/v2/templates.md index 6cc6c85af2b8..6d8d60b52cc2 100644 --- a/docs/src/content/docs/pt-br/docs/v2/templates.md +++ b/docs/src/content/docs/pt-br/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Modelos In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/pt-br/docs/v2/utilities.md b/docs/src/content/docs/pt-br/docs/v2/utilities.md index 500f032dcc69..36e67a5bbdbd 100644 --- a/docs/src/content/docs/pt-br/docs/v2/utilities.md +++ b/docs/src/content/docs/pt-br/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Arquivo -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Câmera diff --git a/docs/src/content/docs/pt-br/downloads/web.mdx b/docs/src/content/docs/pt-br/downloads/web.mdx index 3d34e598b3c3..d62df566aaf6 100644 --- a/docs/src/content/docs/pt-br/downloads/web.mdx +++ b/docs/src/content/docs/pt-br/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Este é um aplicativo progressivo da web. Você pode instalá-lo no navegador e usá-lo offline. Todos os dados são armazenados no seu navegador. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/pt/community/faq.md b/docs/src/content/docs/pt/community/faq.md index 0600cec58557..81f665873a51 100644 --- a/docs/src/content/docs/pt/community/faq.md +++ b/docs/src/content/docs/pt/community/faq.md @@ -23,6 +23,8 @@ Tente atualizar seu navegador para a versão mais recente. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Eu estou usando os dados fornecidos pelo framework de agitação. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Eu estou usando os dados fornecidos pelo framework de agitação. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/pt/community/stylus-support.md b/docs/src/content/docs/pt/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/pt/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/pt/docs/v2/add.md b/docs/src/content/docs/pt/docs/v2/add.md index 503f5d389c81..da8a8eb189da 100644 --- a/docs/src/content/docs/pt/docs/v2/add.md +++ b/docs/src/content/docs/pt/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importar -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Ferramentas -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/pt/docs/v2/collaboration.md b/docs/src/content/docs/pt/docs/v2/collaboration.md index d6b8eaafae8c..9c6b1dc3d5e6 100644 --- a/docs/src/content/docs/pt/docs/v2/collaboration.md +++ b/docs/src/content/docs/pt/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/pt/docs/v2/intro.mdx b/docs/src/content/docs/pt/docs/v2/intro.mdx index a688d9b5fe78..59064cfff5d4 100644 --- a/docs/src/content/docs/pt/docs/v2/intro.mdx +++ b/docs/src/content/docs/pt/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/pt/docs/v2/layers.md b/docs/src/content/docs/pt/docs/v2/layers.md index 09e5655415a8..305a6d8c3778 100644 --- a/docs/src/content/docs/pt/docs/v2/layers.md +++ b/docs/src/content/docs/pt/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/pt/docs/v2/pack.md b/docs/src/content/docs/pt/docs/v2/pack.md index 184713b7d9ad..14c52d0cb92b 100644 --- a/docs/src/content/docs/pt/docs/v2/pack.md +++ b/docs/src/content/docs/pt/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pacote --- -A pack is a collection of components that can be used in the stamp tool. Você pode criar seu próprio pacote ou importar um existente. Para este clique no canto superior esquerdo e clique em "Pacotes". +A pack is a collection of components that can be used in the stamp tool. Você pode criar seu próprio pacote ou importar um existente. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Estilos @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/pt/docs/v2/pages.md b/docs/src/content/docs/pt/docs/v2/pages.md index 075d097a6116..0697a4705e85 100644 --- a/docs/src/content/docs/pt/docs/v2/pages.md +++ b/docs/src/content/docs/pt/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Páginas --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/pt/docs/v2/shortcuts.md b/docs/src/content/docs/pt/docs/v2/shortcuts.md index 16e9f9c09916..9d19f5c73948 100644 --- a/docs/src/content/docs/pt/docs/v2/shortcuts.md +++ b/docs/src/content/docs/pt/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Alguns deles estão escritos abaixo dos botões. ## Caneta -Por padrão, a caneta está configurada para funcionar como o seguinte: +By default, the pen is configured to function as the following: - `Pen`: configurado como caneta. - `Primeiro` (botão principal, se suportado): Mude a ferramenta enquanto pressionado. diff --git a/docs/src/content/docs/pt/docs/v2/storage.md b/docs/src/content/docs/pt/docs/v2/storage.md index 2a52570ceec3..58a05d6dd0f8 100644 --- a/docs/src/content/docs/pt/docs/v2/storage.md +++ b/docs/src/content/docs/pt/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Diretório de dados -O diretório de dados é o diretório onde documentos, modelos e pacotes são armazenados. -Na área de trabalho você pode encontrá-la em `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. No dispositivo móvel está em `getExternalFilesDir(null)/Linwood/Butterfly`. Você também pode alterá-lo nas configurações em `Data`. @@ -22,7 +22,7 @@ Abra as ferramentas de desenvolvedor no seu navegador e você verá os dados. ## Plataformas nativas -Como padrão, a aplicação salva os dados na pasta de documentos em uma subpasta chamada "Linwood/Butterfly". Esta pasta é criada quando você salva os primeiros dados. Esta pasta pode ser alterada nas configurações. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Esta pasta pode ser alterada nas configurações. ## Armazenamento remoto {#remote} @@ -32,12 +32,12 @@ Este recurso não está disponível na web. ::: -O aplicativo pode ser salvo em um servidor remoto. Isso é útil se você quiser compartilhar os dados com outras pessoas ou se você tiver vários computadores. Atualmente, apenas o protocolo `WebDAV` é suportado. +The application data can be stored on a remote server. Isso é útil se você quiser compartilhar os dados com outras pessoas ou se você tiver vários computadores. Atualmente, apenas o protocolo `WebDAV` é suportado. Para adicionar um servidor remoto, vá para as configurações e clique em `Remotes`. Em seguida, clique em 'Adicionar remoto'. Adicione a URL do servidor remoto e o nome de usuário e senha. Depois disso, você pode especificar a pasta onde os dados são armazenados. -Para obter o URL do webdav, por favor, visite a documentação: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (deve se parecer com isto: `https://nextcloud.example.com/remote.php/dav/files/username/`, substitua `username` e `nextcloud.example.com` com os valores corretos) @@ -55,8 +55,8 @@ Existem algumas limitações: ## Outros métodos de armazenamento Se você está em um dispositivo nativo, também pode sincronizar o diretório do aplicativo com a sua plataforma favorita. -O Google drive possui [um aplicativo oficial](https://www.google.com/drive/download/) nas janelas e há ondas não oficiais na Play Store. -No Linux, você também pode usar o sistema de armazenamento remoto nativo e alterar o diretório de dados para isto ou adicionar um novo armazenamento externo se você clicar no botão adicionar conexão. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/pt/docs/v2/templates.md b/docs/src/content/docs/pt/docs/v2/templates.md index 6cc6c85af2b8..6d8d60b52cc2 100644 --- a/docs/src/content/docs/pt/docs/v2/templates.md +++ b/docs/src/content/docs/pt/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Modelos In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/pt/docs/v2/utilities.md b/docs/src/content/docs/pt/docs/v2/utilities.md index 2cb7db85f584..db6f7dc4a5a8 100644 --- a/docs/src/content/docs/pt/docs/v2/utilities.md +++ b/docs/src/content/docs/pt/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Arquivo -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Câmara diff --git a/docs/src/content/docs/pt/downloads/web.mdx b/docs/src/content/docs/pt/downloads/web.mdx index 3d34e598b3c3..d62df566aaf6 100644 --- a/docs/src/content/docs/pt/downloads/web.mdx +++ b/docs/src/content/docs/pt/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Este é um aplicativo progressivo da web. Você pode instalá-lo no navegador e usá-lo offline. Todos os dados são armazenados no seu navegador. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/ro/community/faq.md b/docs/src/content/docs/ro/community/faq.md index a99ac7e75ac3..bec6bceea840 100644 --- a/docs/src/content/docs/ro/community/faq.md +++ b/docs/src/content/docs/ro/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ro/community/stylus-support.md b/docs/src/content/docs/ro/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ro/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ro/docs/v2/add.md b/docs/src/content/docs/ro/docs/v2/add.md index de2b8949f4f2..d1dfae52e6f3 100644 --- a/docs/src/content/docs/ro/docs/v2/add.md +++ b/docs/src/content/docs/ro/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importă -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Unelte -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ro/docs/v2/collaboration.md b/docs/src/content/docs/ro/docs/v2/collaboration.md index 76ecd7c86cb9..49dd23e370de 100644 --- a/docs/src/content/docs/ro/docs/v2/collaboration.md +++ b/docs/src/content/docs/ro/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ro/docs/v2/intro.mdx b/docs/src/content/docs/ro/docs/v2/intro.mdx index a9993b6ebd1b..ad3f69703f24 100644 --- a/docs/src/content/docs/ro/docs/v2/intro.mdx +++ b/docs/src/content/docs/ro/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ro/docs/v2/layers.md b/docs/src/content/docs/ro/docs/v2/layers.md index 6659d28d874e..8781f23f22c7 100644 --- a/docs/src/content/docs/ro/docs/v2/layers.md +++ b/docs/src/content/docs/ro/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ro/docs/v2/pack.md b/docs/src/content/docs/ro/docs/v2/pack.md index f3a2993a120e..727db54e6515 100644 --- a/docs/src/content/docs/ro/docs/v2/pack.md +++ b/docs/src/content/docs/ro/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Pachet --- -A pack is a collection of components that can be used in the stamp tool. Puteți crea propriul pachet sau să importați unul existent. Pentru acest clic în colțul din stânga sus și faceți clic pe "Pachete". +A pack is a collection of components that can be used in the stamp tool. Puteți crea propriul pachet sau să importați unul existent. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ro/docs/v2/pages.md b/docs/src/content/docs/ro/docs/v2/pages.md index 34351b3141ba..1cbfbd3e9fa6 100644 --- a/docs/src/content/docs/ro/docs/v2/pages.md +++ b/docs/src/content/docs/ro/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Pagini --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ro/docs/v2/shortcuts.md b/docs/src/content/docs/ro/docs/v2/shortcuts.md index 85d8f22c411e..53106b4e1e79 100644 --- a/docs/src/content/docs/ro/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ro/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Unele dintre ele sunt scrise sub butoane. ## Stiloul -În mod implicit, stiloul este configurat pentru a funcţiona astfel: +By default, the pen is configured to function as the following: - `Stilu`: configurat ca stilou injector (pen). - `First` (buton principal, dacă este suportat): Schimbă cu unealta de mână în timp ce este apăsată. diff --git a/docs/src/content/docs/ro/docs/v2/storage.md b/docs/src/content/docs/ro/docs/v2/storage.md index f979d22927cc..38f3f158b70e 100644 --- a/docs/src/content/docs/ro/docs/v2/storage.md +++ b/docs/src/content/docs/ro/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Director de date -Dosarul cu date este directorul unde sunt stocate documentele, șabloanele și pachetele. -Pe desktop îl poți găsi în `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. Pe mobil este în `getExternalFilesDir(null)/Linwood/Butterfly`. De asemenea, îl puteţi schimba în setările din `Data`. @@ -22,7 +22,7 @@ Deschideți instrumentele de dezvoltare din browser și veți vedea datele. ## Platforme native -În mod implicit, aplicația salvează datele din dosarul documente într-un subdosar numit "Linwood/Butterfly". Acest folder este creat atunci când salvați primele date. Acest dosar poate fi modificat în setări. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Acest dosar poate fi modificat în setări. ## Stocare la distanță {#remote} @@ -32,12 +32,12 @@ Această caracteristică nu este disponibilă pe web. ::: -Aplicația poate fi salvată pe un server de la distanță. Acest lucru este util dacă doriți să partajați datele cu alte persoane sau dacă aveți mai multe computere. În prezent, numai protocolul `WebDAV` este suportat. +The application data can be stored on a remote server. Acest lucru este util dacă doriți să partajați datele cu alte persoane sau dacă aveți mai multe computere. În prezent, numai protocolul `WebDAV` este suportat. Pentru a adăuga un server de la distanţă, mergeţi la setări şi faceţi clic pe `Remotes`. Apoi faceţi clic pe `Adăugare telecomandă`. Adăugați adresa URL a serverului remote și numele de utilizator și parola. După aceasta, puteți specifica folderul în care sunt stocate datele. -Pentru a obține url-ul webdac, vă rugăm să vizitați documentația: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (ar trebui să arate astfel: `https://nextcloud.example.com/remote.php/dav/files/username/`, înlocuiți `username` și `nextcloud.example.com` cu valorile corecte) @@ -55,8 +55,8 @@ Există câteva limitări: ## Alte metode de depozitare Dacă ești pe un dispozitiv nativ, poți sincroniza și directorul aplicației cu platforma ta preferată. -Google drive are [o aplicație oficială](https://www.google.com/drive/download/) pe ferestre și sunt lucruri neoficiale în magazinul de joacă. -În linux puteţi folosi şi sistemul nativ de stocare la distanţă şi să schimbaţi folderul de date la acesta sau să adăugaţi o nouă stocare externă dacă faceţi clic pe butonul de adăugare conexiune. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### VSG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ro/docs/v2/templates.md b/docs/src/content/docs/ro/docs/v2/templates.md index ab1a0ea1c509..a453a3b605d6 100644 --- a/docs/src/content/docs/ro/docs/v2/templates.md +++ b/docs/src/content/docs/ro/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Şabloane In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ro/docs/v2/utilities.md b/docs/src/content/docs/ro/docs/v2/utilities.md index 1d7ff99aa59d..d2a4acf43290 100644 --- a/docs/src/content/docs/ro/docs/v2/utilities.md +++ b/docs/src/content/docs/ro/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fişier -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Cameră diff --git a/docs/src/content/docs/ro/downloads/web.mdx b/docs/src/content/docs/ro/downloads/web.mdx index d69f83f67a91..37947a0835f2 100644 --- a/docs/src/content/docs/ro/downloads/web.mdx +++ b/docs/src/content/docs/ro/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Link-uri diff --git a/docs/src/content/docs/ru/community/faq.md b/docs/src/content/docs/ru/community/faq.md index 0dda78c36ea7..e069e547e794 100644 --- a/docs/src/content/docs/ru/community/faq.md +++ b/docs/src/content/docs/ru/community/faq.md @@ -23,6 +23,8 @@ Brave Пользователи, которые установили параме > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Я использую вход, предоставленный флэттер. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Я использую вход, предоставленный флэттер. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/ru/community/stylus-support.md b/docs/src/content/docs/ru/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/ru/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/ru/docs/v2/add.md b/docs/src/content/docs/ru/docs/v2/add.md index bc3cb9f4c62d..6151ca6b7c28 100644 --- a/docs/src/content/docs/ru/docs/v2/add.md +++ b/docs/src/content/docs/ru/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Импорт -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Инструменты -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/ru/docs/v2/collaboration.md b/docs/src/content/docs/ru/docs/v2/collaboration.md index d8e476d5e808..b8afa8c98ac4 100644 --- a/docs/src/content/docs/ru/docs/v2/collaboration.md +++ b/docs/src/content/docs/ru/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/ru/docs/v2/intro.mdx b/docs/src/content/docs/ru/docs/v2/intro.mdx index d61a649437b7..9b7e6385cd94 100644 --- a/docs/src/content/docs/ru/docs/v2/intro.mdx +++ b/docs/src/content/docs/ru/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/ru/docs/v2/layers.md b/docs/src/content/docs/ru/docs/v2/layers.md index 49c3e39181ab..c34692476f8c 100644 --- a/docs/src/content/docs/ru/docs/v2/layers.md +++ b/docs/src/content/docs/ru/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/ru/docs/v2/pack.md b/docs/src/content/docs/ru/docs/v2/pack.md index 0eb42d9e403f..7ce4f4194189 100644 --- a/docs/src/content/docs/ru/docs/v2/pack.md +++ b/docs/src/content/docs/ru/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Набор --- -A pack is a collection of components that can be used in the stamp tool. Вы можете создать свой собственный пакет или импортировать уже существующий. Щелкните на верхнем левом углу и нажмите на кнопку «Пакет». +A pack is a collection of components that can be used in the stamp tool. Вы можете создать свой собственный пакет или импортировать уже существующий. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/ru/docs/v2/pages.md b/docs/src/content/docs/ru/docs/v2/pages.md index 555643235759..b5a196c3d9fc 100644 --- a/docs/src/content/docs/ru/docs/v2/pages.md +++ b/docs/src/content/docs/ru/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Страницы --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/ru/docs/v2/shortcuts.md b/docs/src/content/docs/ru/docs/v2/shortcuts.md index da6609fd7e31..eafa5b4e1fee 100644 --- a/docs/src/content/docs/ru/docs/v2/shortcuts.md +++ b/docs/src/content/docs/ru/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: Ярлыки ## Перо -По умолчанию, ручка настроена на работу следующим образом: +By default, the pen is configured to function as the following: - `Pen`: сконфигурирован как pen. - `First` (основная кнопка, если поддерживается): Измените на инструмент вручную. diff --git a/docs/src/content/docs/ru/docs/v2/storage.md b/docs/src/content/docs/ru/docs/v2/storage.md index 7cd4eb595678..6f1ab601bb9f 100644 --- a/docs/src/content/docs/ru/docs/v2/storage.md +++ b/docs/src/content/docs/ru/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Каталог данных -Каталог данных - это каталог, в котором хранятся документы, шаблоны и пакеты. -На рабочем столе вы можете найти его в `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. На мобильном устройстве находится `getExternalFilesDir(null)/Linwood/Butterfly`. Вы также можете изменить его в настройках в разделе «Данные». @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Родной платформы -По умолчанию приложение сохраняет данные в папке документов в подпапке под названием "Linwood/Butterfly". Эта папка создается при сохранении первых данных. Эта папка может быть изменена в настройках. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Эта папка может быть изменена в настройках. ## Удаленное хранилище {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -Приложение может быть сохранено на удаленном сервере. Это полезно, если вы хотите поделиться данными с другими людьми или у вас есть несколько компьютеров. В настоящее время поддерживается только протокол `WebDAV`. +The application data can be stored on a remote server. Это полезно, если вы хотите поделиться данными с другими людьми или у вас есть несколько компьютеров. В настоящее время поддерживается только протокол `WebDAV`. Чтобы добавить удаленный сервер, перейдите в настройки и нажмите `Remotes`. Затем нажмите на `Add remote`. Добавьте URL удаленного сервера и имя пользователя и пароль. После этого можно указать папку, в которой хранятся данные. -Для получения адреса webdav посетите документацию: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (это должно выглядеть так: `https://nextcloud.example.com/remote.php/dav/files/username/`, заменить `username` и `nextcloud.example.com` верными значениями) @@ -55,8 +55,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Другие методы хранения Если вы находитесь на родном устройстве, вы также можете синхронизировать папку приложения с вашей любимой платформой. -В Google диске есть [официальное приложение](https://www.google.com/drive/download/) в Windows, и в Play Store есть неофициальные приложения. -На linux вы также можете использовать родную систему удаленного хранения и изменить папку с данными в эту папку или добавить новое внешнее хранилище, если вы нажмете на кнопку Добавить соединение. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/ru/docs/v2/templates.md b/docs/src/content/docs/ru/docs/v2/templates.md index 767448ddfd8c..a9e374a57ae8 100644 --- a/docs/src/content/docs/ru/docs/v2/templates.md +++ b/docs/src/content/docs/ru/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Шаблоны In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/ru/docs/v2/utilities.md b/docs/src/content/docs/ru/docs/v2/utilities.md index eebe3fb307a5..37d06a52e586 100644 --- a/docs/src/content/docs/ru/docs/v2/utilities.md +++ b/docs/src/content/docs/ru/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Файл -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Снимок diff --git a/docs/src/content/docs/ru/downloads/web.mdx b/docs/src/content/docs/ru/downloads/web.mdx index e895d21bfaf8..1890a2b7cf24 100644 --- a/docs/src/content/docs/ru/downloads/web.mdx +++ b/docs/src/content/docs/ru/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Это прогрессивное веб-приложение. Вы можете установить его в вашем браузере и использовать его в автономном режиме. Все данные хранятся в Вашем браузере. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Ссылки diff --git a/docs/src/content/docs/sr/community/faq.md b/docs/src/content/docs/sr/community/faq.md index 6e7bc736e142..8e3ddc493d9c 100644 --- a/docs/src/content/docs/sr/community/faq.md +++ b/docs/src/content/docs/sr/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/sr/community/stylus-support.md b/docs/src/content/docs/sr/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/sr/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/sr/docs/v2/add.md b/docs/src/content/docs/sr/docs/v2/add.md index 43b959c001cb..fd737b590380 100644 --- a/docs/src/content/docs/sr/docs/v2/add.md +++ b/docs/src/content/docs/sr/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Uvezi -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Alati -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/sr/docs/v2/collaboration.md b/docs/src/content/docs/sr/docs/v2/collaboration.md index e36579cf9c26..446d3088b871 100644 --- a/docs/src/content/docs/sr/docs/v2/collaboration.md +++ b/docs/src/content/docs/sr/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/sr/docs/v2/intro.mdx b/docs/src/content/docs/sr/docs/v2/intro.mdx index 54addb7c86b1..7df64711e034 100644 --- a/docs/src/content/docs/sr/docs/v2/intro.mdx +++ b/docs/src/content/docs/sr/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/sr/docs/v2/layers.md b/docs/src/content/docs/sr/docs/v2/layers.md index 9defbf8938da..1d9934820377 100644 --- a/docs/src/content/docs/sr/docs/v2/layers.md +++ b/docs/src/content/docs/sr/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/sr/docs/v2/pack.md b/docs/src/content/docs/sr/docs/v2/pack.md index e1ebb95e8440..afbbf1bd3439 100644 --- a/docs/src/content/docs/sr/docs/v2/pack.md +++ b/docs/src/content/docs/sr/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paket --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Stilovi @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palete -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/sr/docs/v2/pages.md b/docs/src/content/docs/sr/docs/v2/pages.md index 118a6de0b688..f26739dc10b2 100644 --- a/docs/src/content/docs/sr/docs/v2/pages.md +++ b/docs/src/content/docs/sr/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Stranice --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/sr/docs/v2/shortcuts.md b/docs/src/content/docs/sr/docs/v2/shortcuts.md index 3d4f1c43c58c..81ae1a5ae5d4 100644 --- a/docs/src/content/docs/sr/docs/v2/shortcuts.md +++ b/docs/src/content/docs/sr/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Olovka -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/sr/docs/v2/storage.md b/docs/src/content/docs/sr/docs/v2/storage.md index cb86dd9b139c..2f80341a9270 100644 --- a/docs/src/content/docs/sr/docs/v2/storage.md +++ b/docs/src/content/docs/sr/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Direktorijum sa podacima -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/sr/docs/v2/templates.md b/docs/src/content/docs/sr/docs/v2/templates.md index ba426be47b03..a45c7499bb02 100644 --- a/docs/src/content/docs/sr/docs/v2/templates.md +++ b/docs/src/content/docs/sr/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Šabloni In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/sr/docs/v2/utilities.md b/docs/src/content/docs/sr/docs/v2/utilities.md index 322df75a9a9b..ad8f0162c42b 100644 --- a/docs/src/content/docs/sr/docs/v2/utilities.md +++ b/docs/src/content/docs/sr/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Datoteka -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/sr/downloads/web.mdx b/docs/src/content/docs/sr/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/sr/downloads/web.mdx +++ b/docs/src/content/docs/sr/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/sv/community/faq.md b/docs/src/content/docs/sv/community/faq.md index 67285ca33077..5f2833ad6a83 100644 --- a/docs/src/content/docs/sv/community/faq.md +++ b/docs/src/content/docs/sv/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/sv/community/stylus-support.md b/docs/src/content/docs/sv/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/sv/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/sv/docs/v2/add.md b/docs/src/content/docs/sv/docs/v2/add.md index 4bb368b573e8..ea7947f850e6 100644 --- a/docs/src/content/docs/sv/docs/v2/add.md +++ b/docs/src/content/docs/sv/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Importera -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Verktyg -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/sv/docs/v2/collaboration.md b/docs/src/content/docs/sv/docs/v2/collaboration.md index f20bb4e2e29d..97abe42cae1d 100644 --- a/docs/src/content/docs/sv/docs/v2/collaboration.md +++ b/docs/src/content/docs/sv/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/sv/docs/v2/intro.mdx b/docs/src/content/docs/sv/docs/v2/intro.mdx index 10c1cd1e9ef8..18a605d05608 100644 --- a/docs/src/content/docs/sv/docs/v2/intro.mdx +++ b/docs/src/content/docs/sv/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/sv/docs/v2/layers.md b/docs/src/content/docs/sv/docs/v2/layers.md index 7f7c9fecca3b..f85154173868 100644 --- a/docs/src/content/docs/sv/docs/v2/layers.md +++ b/docs/src/content/docs/sv/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/sv/docs/v2/pack.md b/docs/src/content/docs/sv/docs/v2/pack.md index 8d14c25e0354..c7d2df1cd2bb 100644 --- a/docs/src/content/docs/sv/docs/v2/pack.md +++ b/docs/src/content/docs/sv/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paket --- -A pack is a collection of components that can be used in the stamp tool. Du kan skapa ditt eget paket eller importera ett befintligt. För detta klicka på det övre vänstra hörnet och klicka på "Paket". +A pack is a collection of components that can be used in the stamp tool. Du kan skapa ditt eget paket eller importera ett befintligt. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/sv/docs/v2/pages.md b/docs/src/content/docs/sv/docs/v2/pages.md index e04aae6066ea..adaed4b00e5f 100644 --- a/docs/src/content/docs/sv/docs/v2/pages.md +++ b/docs/src/content/docs/sv/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Sidor --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/sv/docs/v2/shortcuts.md b/docs/src/content/docs/sv/docs/v2/shortcuts.md index 7d79bd709122..e2e87a8be45e 100644 --- a/docs/src/content/docs/sv/docs/v2/shortcuts.md +++ b/docs/src/content/docs/sv/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Några av dem är skrivna under knapparna. ## Penna -Som standard är pennan konfigurerad att fungera som följande: +By default, the pen is configured to function as the following: - `Pen`: konfigurerad som penna. - `First` (Primär knapp, om det stöds): Ändra till handverktyg medan du trycker. diff --git a/docs/src/content/docs/sv/docs/v2/storage.md b/docs/src/content/docs/sv/docs/v2/storage.md index d2cee63a937f..a3ac6feb6c6a 100644 --- a/docs/src/content/docs/sv/docs/v2/storage.md +++ b/docs/src/content/docs/sv/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Datakatalog -Datakatalogen är den katalog där dokument, mallar och paket lagras. -På skrivbordet hittar du den i `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. På mobilen finns det i `getExternalFilesDir(null)/Linwood/Butterfly`. Du kan också ändra det i inställningarna under `Data`. @@ -22,7 +22,7 @@ Applikationsdata lagras i din webbläsare. Den lagras i en lokal lagring. ## Inhemska plattformar -Som standard sparar programmet data i din dokumentmapp i en undermapp som heter "Linwood/Butterfly". Den här mappen skapas när du sparar den första datan. Denna mapp kan ändras i inställningarna. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Denna mapp kan ändras i inställningarna. ## Fjärrlagring {#remote} @@ -32,12 +32,12 @@ Denna funktion är inte tillgänglig på webben. ::: -Applikationen kan sparas på en fjärrserver. Detta är användbart om du vill dela data med andra människor eller om du har flera datorer. För närvarande stöds endast `WebDAV`-protokollet. +The application data can be stored on a remote server. Detta är användbart om du vill dela data med andra människor eller om du har flera datorer. För närvarande stöds endast `WebDAV`-protokollet. För att lägga till en fjärrserver, gå till inställningarna och klicka på `Remotes`. Klicka sedan på `Add remote`. Lägg till URL till fjärrservern och användarnamn och lösenord. Därefter kan du ange den mapp där data lagras. -Gå till dokumentationen för att få webbav-urlen: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (det ska se ut så här: `https://nextcloud.example.com/remote.php/dav/files/username/`, ersätt `username` och `nextcloud.example.com` med rätt värden) @@ -55,8 +55,8 @@ Det finns några begränsningar: ## Andra lagringsmetoder Om du är på en infödd enhet kan du även synkronisera applikationskatalogen med din favoritplattform. -Google drive har [en officiell app](https://www.google.com/drive/download/) på windows och det finns inofficiella en gång i play store. -På Linux kan du också använda det inbyggda fjärrlagringssystemet och ändra datakatalogen till detta eller lägga till ett nytt externt lagringsutrymme om du klickar på knappen Lägg till anslutning. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/sv/docs/v2/templates.md b/docs/src/content/docs/sv/docs/v2/templates.md index 1a983ccf54dc..eb74cac2ba9b 100644 --- a/docs/src/content/docs/sv/docs/v2/templates.md +++ b/docs/src/content/docs/sv/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Mallar In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/sv/docs/v2/utilities.md b/docs/src/content/docs/sv/docs/v2/utilities.md index 04449c43ec79..2dc2695c11aa 100644 --- a/docs/src/content/docs/sv/docs/v2/utilities.md +++ b/docs/src/content/docs/sv/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Fil -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/sv/downloads/web.mdx b/docs/src/content/docs/sv/downloads/web.mdx index 1d4486e0619f..f87644c2b7df 100644 --- a/docs/src/content/docs/sv/downloads/web.mdx +++ b/docs/src/content/docs/sv/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Länkar diff --git a/docs/src/content/docs/th/community/faq.md b/docs/src/content/docs/th/community/faq.md index a7f761e76c5c..8baa3ff8a171 100644 --- a/docs/src/content/docs/th/community/faq.md +++ b/docs/src/content/docs/th/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/th/community/stylus-support.md b/docs/src/content/docs/th/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/th/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/th/docs/v2/add.md b/docs/src/content/docs/th/docs/v2/add.md index 96b349332742..633beb93ebd8 100644 --- a/docs/src/content/docs/th/docs/v2/add.md +++ b/docs/src/content/docs/th/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## นำเข้า -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## เครื่องมือ -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/th/docs/v2/collaboration.md b/docs/src/content/docs/th/docs/v2/collaboration.md index 335cfeb80155..a5d96d0400ab 100644 --- a/docs/src/content/docs/th/docs/v2/collaboration.md +++ b/docs/src/content/docs/th/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/th/docs/v2/intro.mdx b/docs/src/content/docs/th/docs/v2/intro.mdx index a4f29ea9a127..26d92fd60597 100644 --- a/docs/src/content/docs/th/docs/v2/intro.mdx +++ b/docs/src/content/docs/th/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/th/docs/v2/layers.md b/docs/src/content/docs/th/docs/v2/layers.md index 45ba5ae071e3..99d4c3efc707 100644 --- a/docs/src/content/docs/th/docs/v2/layers.md +++ b/docs/src/content/docs/th/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/th/docs/v2/pack.md b/docs/src/content/docs/th/docs/v2/pack.md index 700f80055aed..83dcfa7919cc 100644 --- a/docs/src/content/docs/th/docs/v2/pack.md +++ b/docs/src/content/docs/th/docs/v2/pack.md @@ -2,7 +2,7 @@ title: แพ็ก --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## สไตล์ @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## พาเลต -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/th/docs/v2/pages.md b/docs/src/content/docs/th/docs/v2/pages.md index 46d826fbba84..44e1bfcf8d90 100644 --- a/docs/src/content/docs/th/docs/v2/pages.md +++ b/docs/src/content/docs/th/docs/v2/pages.md @@ -2,7 +2,7 @@ title: หน้า --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/th/docs/v2/shortcuts.md b/docs/src/content/docs/th/docs/v2/shortcuts.md index bd435ec4af5e..3b9b42ef274c 100644 --- a/docs/src/content/docs/th/docs/v2/shortcuts.md +++ b/docs/src/content/docs/th/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## ปากกา -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/th/docs/v2/storage.md b/docs/src/content/docs/th/docs/v2/storage.md index 21148ba00f3c..56c783b8b4cd 100644 --- a/docs/src/content/docs/th/docs/v2/storage.md +++ b/docs/src/content/docs/th/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## ไดเรกทอรีข้อมูล -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/th/docs/v2/templates.md b/docs/src/content/docs/th/docs/v2/templates.md index 76de67be5880..ed5dbcb4f61c 100644 --- a/docs/src/content/docs/th/docs/v2/templates.md +++ b/docs/src/content/docs/th/docs/v2/templates.md @@ -4,7 +4,7 @@ title: แม่แบบ In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/th/docs/v2/utilities.md b/docs/src/content/docs/th/docs/v2/utilities.md index b6188ec7ed20..dd9bf98d8013 100644 --- a/docs/src/content/docs/th/docs/v2/utilities.md +++ b/docs/src/content/docs/th/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## ไฟล์ -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## กล้อง diff --git a/docs/src/content/docs/th/downloads/web.mdx b/docs/src/content/docs/th/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/th/downloads/web.mdx +++ b/docs/src/content/docs/th/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/tr/community/faq.md b/docs/src/content/docs/tr/community/faq.md index 1068712f33f6..e4404fa3abb1 100644 --- a/docs/src/content/docs/tr/community/faq.md +++ b/docs/src/content/docs/tr/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + Flutter çerçevesi tarafından sağlanan girdiyi kullanıyorum. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + Flutter çerçevesi tarafından sağlanan girdiyi kullanıyorum. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/tr/community/stylus-support.md b/docs/src/content/docs/tr/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/tr/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/tr/docs/v2/add.md b/docs/src/content/docs/tr/docs/v2/add.md index 99ec5172f4e6..557e6b812859 100644 --- a/docs/src/content/docs/tr/docs/v2/add.md +++ b/docs/src/content/docs/tr/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## İçe aktar -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Aletler -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/tr/docs/v2/collaboration.md b/docs/src/content/docs/tr/docs/v2/collaboration.md index 4953d98644d8..88fc442a820d 100644 --- a/docs/src/content/docs/tr/docs/v2/collaboration.md +++ b/docs/src/content/docs/tr/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/tr/docs/v2/intro.mdx b/docs/src/content/docs/tr/docs/v2/intro.mdx index 9a6a53ad51fe..f3e02133cd60 100644 --- a/docs/src/content/docs/tr/docs/v2/intro.mdx +++ b/docs/src/content/docs/tr/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/tr/docs/v2/layers.md b/docs/src/content/docs/tr/docs/v2/layers.md index efcbde87be44..5936f9735df3 100644 --- a/docs/src/content/docs/tr/docs/v2/layers.md +++ b/docs/src/content/docs/tr/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/tr/docs/v2/pack.md b/docs/src/content/docs/tr/docs/v2/pack.md index a6cd6b905ae8..cb663fe94178 100644 --- a/docs/src/content/docs/tr/docs/v2/pack.md +++ b/docs/src/content/docs/tr/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Paket --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Stiller @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Paletler -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/tr/docs/v2/pages.md b/docs/src/content/docs/tr/docs/v2/pages.md index ae3dd53eca38..85966e37bc32 100644 --- a/docs/src/content/docs/tr/docs/v2/pages.md +++ b/docs/src/content/docs/tr/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Sayfalar --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/tr/docs/v2/shortcuts.md b/docs/src/content/docs/tr/docs/v2/shortcuts.md index 636b4c4078d3..05e0e1982767 100644 --- a/docs/src/content/docs/tr/docs/v2/shortcuts.md +++ b/docs/src/content/docs/tr/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Bazıları düğmelerin altında yazılmıştır. ## Kalem -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/tr/docs/v2/storage.md b/docs/src/content/docs/tr/docs/v2/storage.md index 978f9e94c6b9..0ccec189bd9c 100644 --- a/docs/src/content/docs/tr/docs/v2/storage.md +++ b/docs/src/content/docs/tr/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Veri dizini -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Tarayıcınızda geliştirici araçlarını açın, verileri göreceksiniz. ## Yerel Platformlar -Varsayılan olarak uygulama verileriö belgeler klasörünüzdeki "Linwood/Butterfly" adlı bir alt klasöre kaydeder. Bu klasör, ilk veri kaydınızda oluşturulur. Bu klasör ayarlardan değiştirilebilir. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Bu klasör ayarlardan değiştirilebilir. ## Remote storage {#remote} @@ -32,12 +32,12 @@ Bu özellik web'de mevcut değildir. ::: -Uygulama uzak bir sunucuya kaydedilebilir. Bu, verileri başkalarıyla paylaşmak istiyorsanız veya birden fazla bilgisayarınız varsa kullanışlıdır. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. Bu, verileri başkalarıyla paylaşmak istiyorsanız veya birden fazla bilgisayarınız varsa kullanışlıdır. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Uzak sunucunun URL'sini, kullanıcı adını ve şifreyi ekleyin. Bundan sonra verilerin depolandığı klasörü belirleyebilirsiniz. -Webdav Url'sini almak için lütfen belgeleri ziyaret edin: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ Birkaç sınırlama vardır: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/tr/docs/v2/templates.md b/docs/src/content/docs/tr/docs/v2/templates.md index 027ee087d107..77e07c4896f0 100644 --- a/docs/src/content/docs/tr/docs/v2/templates.md +++ b/docs/src/content/docs/tr/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Şablonlar In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/tr/docs/v2/utilities.md b/docs/src/content/docs/tr/docs/v2/utilities.md index 2b490122d562..535202013461 100644 --- a/docs/src/content/docs/tr/docs/v2/utilities.md +++ b/docs/src/content/docs/tr/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Dosya -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Kamera diff --git a/docs/src/content/docs/tr/downloads/web.mdx b/docs/src/content/docs/tr/downloads/web.mdx index 25a800a4ee65..85b0768df641 100644 --- a/docs/src/content/docs/tr/downloads/web.mdx +++ b/docs/src/content/docs/tr/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; Bu ilerici bir web uygulamasıdır. Tarayıcınıza yükleyebilir ve çevrimdışı kullanabilirsiniz. Tüm veriler tarayıcınızda saklanır. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Bağlantılar diff --git a/docs/src/content/docs/uk/community/faq.md b/docs/src/content/docs/uk/community/faq.md index 55ac78e8054a..03c0e73e09aa 100644 --- a/docs/src/content/docs/uk/community/faq.md +++ b/docs/src/content/docs/uk/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/uk/community/stylus-support.md b/docs/src/content/docs/uk/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/uk/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/uk/docs/v2/add.md b/docs/src/content/docs/uk/docs/v2/add.md index 2cc498a385e2..de2ac52682d7 100644 --- a/docs/src/content/docs/uk/docs/v2/add.md +++ b/docs/src/content/docs/uk/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Імпорт -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Інструменти -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/uk/docs/v2/collaboration.md b/docs/src/content/docs/uk/docs/v2/collaboration.md index 4f3261d3dd3a..9da0dfd5a574 100644 --- a/docs/src/content/docs/uk/docs/v2/collaboration.md +++ b/docs/src/content/docs/uk/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/uk/docs/v2/intro.mdx b/docs/src/content/docs/uk/docs/v2/intro.mdx index f4e9ea10a314..9a04f610c935 100644 --- a/docs/src/content/docs/uk/docs/v2/intro.mdx +++ b/docs/src/content/docs/uk/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/uk/docs/v2/layers.md b/docs/src/content/docs/uk/docs/v2/layers.md index 3df1400984fe..ae5b1447478e 100644 --- a/docs/src/content/docs/uk/docs/v2/layers.md +++ b/docs/src/content/docs/uk/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/uk/docs/v2/pack.md b/docs/src/content/docs/uk/docs/v2/pack.md index 15728fb153d7..6b11ed7c1537 100644 --- a/docs/src/content/docs/uk/docs/v2/pack.md +++ b/docs/src/content/docs/uk/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Набір --- -A pack is a collection of components that can be used in the stamp tool. Ви можете створити власний пакет або імпортувати наявний. Для цього клацніть на лівому верхньому лівому куті та натисніть на "Пакунки". +A pack is a collection of components that can be used in the stamp tool. Ви можете створити власний пакет або імпортувати наявний. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/uk/docs/v2/pages.md b/docs/src/content/docs/uk/docs/v2/pages.md index 9c645c4db886..099a3a2dfe86 100644 --- a/docs/src/content/docs/uk/docs/v2/pages.md +++ b/docs/src/content/docs/uk/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Сторінки --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/uk/docs/v2/shortcuts.md b/docs/src/content/docs/uk/docs/v2/shortcuts.md index 77fb2d6f76d3..66c57238a9c0 100644 --- a/docs/src/content/docs/uk/docs/v2/shortcuts.md +++ b/docs/src/content/docs/uk/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: Гарячі клавіші ## Ручка -За замовчуванням, ручка налаштована для функції в такому випадку: +By default, the pen is configured to function as the following: - `Пен`: налаштований як ручка. - `Перший` (основна кнопка, якщо підтримується): Поміняйте на інструмент керування при натисканні кнопки вручну. diff --git a/docs/src/content/docs/uk/docs/v2/storage.md b/docs/src/content/docs/uk/docs/v2/storage.md index 39ed82fd8760..935b4f71bcfc 100644 --- a/docs/src/content/docs/uk/docs/v2/storage.md +++ b/docs/src/content/docs/uk/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Каталог даних -Каталог даних є каталогом, де зберігаються документи, шаблони і пакети. -На комп'ютері ви можете знайти його в `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. На мобільному телефоні він (getExternalFilesDir(null)/Linwood/Butterfly\`. Ви також можете змінити його в налаштуваннях в розділі "Data". @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Самородні платформи -Як за замовчуванням програма зберігає дані у папці ваших документів у підпапці під назвою "Linwood/Butterfly". Ця папка створюється під час збереження перших даних. Цю папку можна змінити в налаштуваннях. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. Цю папку можна змінити в налаштуваннях. ## Віддалене сховище {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -Програму можна зберегти на віддаленому сервері. Це корисно, якщо ви хочете поділитись даними з іншими людьми або якщо у вас є декілька комп'ютерів. На даний момент підтримується тільки протокол WebDAV. +The application data can be stored on a remote server. Це корисно, якщо ви хочете поділитись даними з іншими людьми або якщо у вас є декілька комп'ютерів. На даний момент підтримується тільки протокол WebDAV. Щоб додати віддалений сервер, перейдіть до налаштувань та натисніть `Remotes`. Потім натисніть "Додати пульт". Додайте URL-адресу віддаленого сервера, ім'я користувача і пароль. Після цього ви можете вказати папку, де зберігаються дані. -Щоб отримати адресу webdav url, будь ласка, відвідайте документацію: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (це має виглядати так: `https://nextcloud.example.com/remote.php/dav/files/username/`, замінити `username` і `nextcloud.example.com` з правильними значеннями) @@ -55,8 +55,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Інші методи зберігання Якщо ви на рідному пристрої, ви також можете синхронізувати каталог програми з вашою улюбленою платформою. -У Google drive [офіційний додаток](https://www.google.com/drive/download/) у вікнах, і в магазині ігор є неофіційні. -На linux ви також можете використовувати систему віддаленого сховища та змінити ваш каталог даних на це або додати нове зовнішнє сховище, якщо натиснути кнопку додавання підключення. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/uk/docs/v2/templates.md b/docs/src/content/docs/uk/docs/v2/templates.md index cd732dde101b..3c9d45714795 100644 --- a/docs/src/content/docs/uk/docs/v2/templates.md +++ b/docs/src/content/docs/uk/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Шаблони In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/uk/docs/v2/utilities.md b/docs/src/content/docs/uk/docs/v2/utilities.md index 9e60f2dc9ede..0c61beca62fc 100644 --- a/docs/src/content/docs/uk/docs/v2/utilities.md +++ b/docs/src/content/docs/uk/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Файл -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Камера diff --git a/docs/src/content/docs/uk/downloads/web.mdx b/docs/src/content/docs/uk/downloads/web.mdx index 3fb3528d91bf..d2a77f2ebd41 100644 --- a/docs/src/content/docs/uk/downloads/web.mdx +++ b/docs/src/content/docs/uk/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Посилання diff --git a/docs/src/content/docs/vi/community/faq.md b/docs/src/content/docs/vi/community/faq.md index 102cb69e4ee9..ed75815e61c4 100644 --- a/docs/src/content/docs/vi/community/faq.md +++ b/docs/src/content/docs/vi/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/vi/community/stylus-support.md b/docs/src/content/docs/vi/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/vi/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/vi/docs/v2/add.md b/docs/src/content/docs/vi/docs/v2/add.md index 8ea00b099eb8..b41addbc2629 100644 --- a/docs/src/content/docs/vi/docs/v2/add.md +++ b/docs/src/content/docs/vi/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## Nhập -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## Công cụ -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/vi/docs/v2/collaboration.md b/docs/src/content/docs/vi/docs/v2/collaboration.md index 07b0a1c69814..46b3756dab8b 100644 --- a/docs/src/content/docs/vi/docs/v2/collaboration.md +++ b/docs/src/content/docs/vi/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/vi/docs/v2/intro.mdx b/docs/src/content/docs/vi/docs/v2/intro.mdx index 958509cec6c2..55c6d7afe088 100644 --- a/docs/src/content/docs/vi/docs/v2/intro.mdx +++ b/docs/src/content/docs/vi/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/vi/docs/v2/layers.md b/docs/src/content/docs/vi/docs/v2/layers.md index fa6124b6d26e..9d985362159a 100644 --- a/docs/src/content/docs/vi/docs/v2/layers.md +++ b/docs/src/content/docs/vi/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/vi/docs/v2/pack.md b/docs/src/content/docs/vi/docs/v2/pack.md index a4bea848d66f..0aa2b47eafe9 100644 --- a/docs/src/content/docs/vi/docs/v2/pack.md +++ b/docs/src/content/docs/vi/docs/v2/pack.md @@ -2,7 +2,7 @@ title: Gói --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Kiểu dáng @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Bảng màu -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/vi/docs/v2/pages.md b/docs/src/content/docs/vi/docs/v2/pages.md index 33f3c3b79933..e577fe2c1aef 100644 --- a/docs/src/content/docs/vi/docs/v2/pages.md +++ b/docs/src/content/docs/vi/docs/v2/pages.md @@ -2,7 +2,7 @@ title: Trang --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/vi/docs/v2/shortcuts.md b/docs/src/content/docs/vi/docs/v2/shortcuts.md index 4e0d37fdfec4..ec2721cbd4f3 100644 --- a/docs/src/content/docs/vi/docs/v2/shortcuts.md +++ b/docs/src/content/docs/vi/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## Bút vẽ -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/vi/docs/v2/storage.md b/docs/src/content/docs/vi/docs/v2/storage.md index 9aa1e60dbb91..63ac2a929250 100644 --- a/docs/src/content/docs/vi/docs/v2/storage.md +++ b/docs/src/content/docs/vi/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## Thư mục dữ liệu -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/vi/docs/v2/templates.md b/docs/src/content/docs/vi/docs/v2/templates.md index b4f8e9196f90..96167316b188 100644 --- a/docs/src/content/docs/vi/docs/v2/templates.md +++ b/docs/src/content/docs/vi/docs/v2/templates.md @@ -4,7 +4,7 @@ title: Mẫu In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/vi/docs/v2/utilities.md b/docs/src/content/docs/vi/docs/v2/utilities.md index 31f9967d160e..c9d0ac7c79b7 100644 --- a/docs/src/content/docs/vi/docs/v2/utilities.md +++ b/docs/src/content/docs/vi/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## Tệp tin -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## Máy ảnh diff --git a/docs/src/content/docs/vi/downloads/web.mdx b/docs/src/content/docs/vi/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/vi/downloads/web.mdx +++ b/docs/src/content/docs/vi/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/zh-hant/community/faq.md b/docs/src/content/docs/zh-hant/community/faq.md index 642742f85dc0..85143b081f92 100644 --- a/docs/src/content/docs/zh-hant/community/faq.md +++ b/docs/src/content/docs/zh-hant/community/faq.md @@ -23,6 +23,8 @@ Try updating your browser to the latest version. > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + I'm using the input provided by the flutter framework. This is the issue to track it: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846). @@ -58,6 +60,8 @@ Butterfly is available on iOS as preview. Click [here](https://butterfly.linwood > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + I'm using the input provided by the flutter framework. There are already issues to track it: Windows: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) and [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). diff --git a/docs/src/content/docs/zh-hant/community/stylus-support.md b/docs/src/content/docs/zh-hant/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/zh-hant/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/zh-hant/docs/v2/add.md b/docs/src/content/docs/zh-hant/docs/v2/add.md index f85cb3b635ae..55f3d35884f8 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/add.md +++ b/docs/src/content/docs/zh-hant/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## 匯入 -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## 工具 -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/zh-hant/docs/v2/collaboration.md b/docs/src/content/docs/zh-hant/docs/v2/collaboration.md index 50b1a5833d68..419e8a831919 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/collaboration.md +++ b/docs/src/content/docs/zh-hant/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/zh-hant/docs/v2/intro.mdx b/docs/src/content/docs/zh-hant/docs/v2/intro.mdx index 4148406c4a13..47f088ffb039 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/intro.mdx +++ b/docs/src/content/docs/zh-hant/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/zh-hant/docs/v2/layers.md b/docs/src/content/docs/zh-hant/docs/v2/layers.md index e1b7272838e0..2483d8936ac1 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/layers.md +++ b/docs/src/content/docs/zh-hant/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/zh-hant/docs/v2/pack.md b/docs/src/content/docs/zh-hant/docs/v2/pack.md index 672b3a2c2117..a59d1fa732bd 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/pack.md +++ b/docs/src/content/docs/zh-hant/docs/v2/pack.md @@ -2,7 +2,7 @@ title: 素材包 --- -A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs". +A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## 樣式 @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## 調色板 -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/zh-hant/docs/v2/pages.md b/docs/src/content/docs/zh-hant/docs/v2/pages.md index fcf41288172b..d27fc2557fe9 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/pages.md +++ b/docs/src/content/docs/zh-hant/docs/v2/pages.md @@ -2,7 +2,7 @@ title: 頁面 --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/zh-hant/docs/v2/shortcuts.md b/docs/src/content/docs/zh-hant/docs/v2/shortcuts.md index 208f108f9983..24c4ff5cef92 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/shortcuts.md +++ b/docs/src/content/docs/zh-hant/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ Some of them are written below the buttons. ## 筆 -By default, the the pen is configured to function as the following: +By default, the pen is configured to function as the following: - `Pen`: configured as pen. - `First` (Primary button, if supported): Change to hand tool while pressed. diff --git a/docs/src/content/docs/zh-hant/docs/v2/storage.md b/docs/src/content/docs/zh-hant/docs/v2/storage.md index cd5ae11be6aa..5bedb7909c68 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/storage.md +++ b/docs/src/content/docs/zh-hant/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## 資料夾 -The data directory is the directory where documents, templates and packs are stored. -On the desktop you can found it in `~/Documents/Linwood/Butterfly`. +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. On mobile it's in `getExternalFilesDir(null)/Linwood/Butterfly`. You can also change it in the settings under `Data`. @@ -22,7 +22,7 @@ Open the developer tools in your browser and you will see the data. ## Native platforms -As default the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save the first data. This folder can be changed in the settings. +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. This folder can be changed in the settings. ## Remote storage {#remote} @@ -32,12 +32,12 @@ This feature is not available on the web. ::: -The application can be saved in a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. +The application data can be stored on a remote server. This is useful if you want to share the data with other people or if you have multiple computers. Currently only the `WebDAV` protocol is supported. To add a remote server, go to the settings and click on `Remotes`. Then click on `Add remote`. Add the URL of the remote server and the username and password. After that you can specify the folder where the data is stored. -To get the webdav url, please visit the documentation: +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) (it should look like this: `https://nextcloud.example.com/remote.php/dav/files/username/`, replace `username` and `nextcloud.example.com` with the correct values) @@ -55,8 +55,8 @@ There are a few limitations: ## Other storage methods If you are on a native device you can also sync the application directory with your favorite platform. -Google drive has [an official app](https://www.google.com/drive/download/) on windows and there are unofficial onces on the play store. -On linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/zh-hant/docs/v2/templates.md b/docs/src/content/docs/zh-hant/docs/v2/templates.md index ddf8cf95c5fc..c8b0fea6bef6 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/templates.md +++ b/docs/src/content/docs/zh-hant/docs/v2/templates.md @@ -4,7 +4,7 @@ title: 模板 In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/zh-hant/docs/v2/utilities.md b/docs/src/content/docs/zh-hant/docs/v2/utilities.md index 4857a3c81549..375f32903dd4 100644 --- a/docs/src/content/docs/zh-hant/docs/v2/utilities.md +++ b/docs/src/content/docs/zh-hant/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## 檔案 -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## 鏡頭 diff --git a/docs/src/content/docs/zh-hant/downloads/web.mdx b/docs/src/content/docs/zh-hant/downloads/web.mdx index 05ef6ff61e1a..662714bc1273 100644 --- a/docs/src/content/docs/zh-hant/downloads/web.mdx +++ b/docs/src/content/docs/zh-hant/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; This is a progressive web application. You can install it on your browser and use it offline. All data is stored in your browser. +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## Links diff --git a/docs/src/content/docs/zh/community/faq.md b/docs/src/content/docs/zh/community/faq.md index d4d4290a396a..84d8d5b4b356 100644 --- a/docs/src/content/docs/zh/community/faq.md +++ b/docs/src/content/docs/zh/community/faq.md @@ -23,6 +23,8 @@ title: 常见问题 > [#270](https://github.com/LinwoodDev/Butterfly/issues/270) +See [Stylus support](/community/stylus-support) for current behavior and workarounds. + 我使用流体框架提供的输入。 查看相关issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) @@ -58,6 +60,8 @@ Butterfly在iOS下有预览版。 点击此[链接](https://butterfly.linwood.de > [#238](https://github.com/LinwoodDev/Butterfly/issues/238) +See [Stylus support](/community/stylus-support) for current behavior, settings, and issue links. + 我使用流体框架提供的输入。 查看相关issue: Windows[flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248) 以及 [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836). Linux: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) diff --git a/docs/src/content/docs/zh/community/stylus-support.md b/docs/src/content/docs/zh/community/stylus-support.md new file mode 100644 index 000000000000..351bb8e5db0c --- /dev/null +++ b/docs/src/content/docs/zh/community/stylus-support.md @@ -0,0 +1,39 @@ +--- +title: Stylus support +--- + +This page collects the current stylus and pen-input behavior in Butterfly. + +## Supported platforms + +- **Android / mobile:** Stylus input works best and is the main supported path today. +- **Desktop (Windows/Linux):** Stylus input is currently limited by Flutter input support. +- **Web:** Often a good fallback when desktop stylus behavior is inconsistent. + +## Stylus-related settings + +You can find stylus-related options in **Settings → Input → Pen**: + +- **Pen-only input** (changed in 2.5): helps avoid accidental finger/touch drawing when using a stylus. +- **Pen-only toggle on stylus detection:** when a stylus is detected, a quick Pen-only toggle is activated; you can still disable it in **Settings → Input → Pen**. +- **Ignore pressure:** useful when pressure data is unreliable. This is set to help with cases where Firefox reports incorrect pressure on first input. +- **Input test:** lets you verify what pointer/stylus events your device is currently reporting. + +## Pen shortcuts and pointer test + +Butterfly supports pen/stylus shortcuts (button mappings can vary by device/OS). If shortcuts do not behave as expected, open **Input test** first and check button values: + +- **Primary button** commonly appears as `10` (`2`) +- **Secondary button** commonly appears as `100` (`4`) or `100000` (`32`) + +These values are bit mappings from pointer button flags. + +## Known framework limitations + +Some stylus issues come from Flutter input handling rather than Butterfly directly. + +- Android S-Pen tracking issue: [flutter/flutter#42846](https://github.com/flutter/flutter/issues/42846) +- Windows stylus issues: [flutter/flutter#65248](https://github.com/flutter/flutter/issues/65248), [flutter/flutter#102836](https://github.com/flutter/flutter/issues/102836) +- Linux stylus issue: [flutter/flutter#63209](https://github.com/flutter/flutter/issues/63209) + +If your setup is affected, please still report it in Butterfly issues with your platform, device model, and app version. diff --git a/docs/src/content/docs/zh/docs/v2/add.md b/docs/src/content/docs/zh/docs/v2/add.md index 57df6e0e31a9..ad3ac7f45aeb 100644 --- a/docs/src/content/docs/zh/docs/v2/add.md +++ b/docs/src/content/docs/zh/docs/v2/add.md @@ -6,12 +6,12 @@ Here you can add things to your notes. ## 导入 -Here you can import existing files inside your documents. -Supported are butterfly documents, markdown, png, svg and pdf. +Here you can import existing files into your documents. +Supported are Butterfly documents, Markdown, PNG, SVG, and PDF. ## 工具 -To add more tools to your toolbar, click on them. +To add tools to your toolbar, click them. Read more about them [here](../tools). ## Surfaces diff --git a/docs/src/content/docs/zh/docs/v2/collaboration.md b/docs/src/content/docs/zh/docs/v2/collaboration.md index 42eff2abc989..dca8dba8d94b 100644 --- a/docs/src/content/docs/zh/docs/v2/collaboration.md +++ b/docs/src/content/docs/zh/docs/v2/collaboration.md @@ -15,18 +15,18 @@ Since the 2.0 beta version, Butterfly supports collaboration. This means that yo ## Swamp -Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end to end encrypted. +Swamp is a protocol that allows you to share your document with other people by using a remote server. This is useful if the other person is not in the same network as you. The server will just be a proxy for the connection and cannot read the data since it is all end-to-end encrypted. -### Setup Sawmp +### Setup Swamp Create a swamp server by visiting the [swamp website](https://swamp.linwood.dev). -Now enter the url of the server in the collaboration view. The url should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. +Now enter the URL of the server in the collaboration view. The URL should look like this: `wss://example.com` or `ws://example.com`. Please note that only secure connections are allowed on the web. Please also make sure that the server is reachable from the internet. Now you can just click on `Start` to start the server. With the given link you can share the document with other people. They can just enter the link in the connect dialog and click on `Connect`. This will connect them to the server and they will be able to edit the document. -## Websocket +## WebSocket -Butterfly uses a websocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server sync all changes and events with all clients. +Butterfly uses a WebSocket server that will be hosted on your computer. This server needs to be accessible from the internet or your local network. The client will connect to this server. The server syncs all changes and events with all clients. ### Setup the server @@ -36,9 +36,9 @@ This server feature is not available on the web. ::: -Firstly, enable the collaboration experiment in the settings. After that open your document you want to share. Then click on the share button in the top left corner right to the title. This will open a dialog. Click on `Start server`. +Firstly, enable the collaboration experiment in the settings. After that, open the document you want to share. Then click on the share button in the top-left corner, to the right of the title. This will open a dialog. Click on `Start server`. -Default the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. +By default, the server will be hosted on all interfaces on port `28005`. You can change this in the dialog. You need to make sure that this server is accessible to the client. In the local network this should work out of the box. If you want to access the server from the internet, you need to forward the port in your router. You can find more information about this [here](https://en.wikipedia.org/wiki/Port_forwarding/). If you cannot forward the port, you can use a service like [ngrok](https://ngrok.com/). This will create a tunnel to your local server. This is useful if you want to share the document with other people. @@ -53,10 +53,10 @@ ngrok http 28005 Now you need to connect to the server. To do this, go to the home page and click on the plus button like you would create a new document. There you will see a new menu item called `Connect`. -Click on this and you will see a dialog. Enter the connection url here. -If you are in the same network, you can use the local ip address of the computer where the server is running. -The url should look like this: `ws://{ip}:28005`. Replace `{ip}` with the ip address of the computer. You can find the ip address with the command `ipconfig` on windows or `ifconfig` on linux. On android you can find the ip address in the wifi settings. +Click on this and you will see a dialog. Enter the connection URL here. +If you are in the same network, you can use the local IP address of the computer where the server is running. +The URL should look like this: `ws://{ip}:28005`. Replace `{ip}` with the IP address of the computer. You can find the IP address with the command `ipconfig` on Windows or `ifconfig` on Linux. On Android you can find the IP address in the Wi‑Fi settings. -If you are not in the same network, you need to use the public ip address of the computer. You can find this by searching for `what is my ip` in your favorite search browser. The url should look like the one above, but with the public ip address. +If you are not in the same network, you need to use the public IP address of the computer. You can find this by searching for `what is my IP` in your favorite search engine. The URL should look like the one above, but with the public IP address. -If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The url should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. +If you use ngrok, the setup is a bit different. Replace the `https` with `wss` and add the port `:28005` at the end. The URL should look like this: `wss://{random}:28005`. Replace the random part with the part that ngrok gives you. diff --git a/docs/src/content/docs/zh/docs/v2/intro.mdx b/docs/src/content/docs/zh/docs/v2/intro.mdx index 791b5d4c7688..46f6bd4b20c0 100644 --- a/docs/src/content/docs/zh/docs/v2/intro.mdx +++ b/docs/src/content/docs/zh/docs/v2/intro.mdx @@ -64,7 +64,7 @@ To start working on the app, you have two options: When opening Butterfly on a mobile device, you will be presented with a screen like this: ![Welcome screen first part](welcome_screen_mobile_1.png) - The top of the screen you will see the release name and a link to the release notes and documentation. + At the top of the screen you will see the release name and a link to the release notes and documentation. Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files. @@ -73,7 +73,7 @@ To start working on the app, you have two options: ![Welcome screen second part](welcome_screen_mobile_2.png) Here, you can do the following operations: * Select the display type ( Grid or List) - * Reloading the file list + * Reload the file list * Select the [source storage](../storage) of the files * Sort the display order of the files * Add a folder, file, template, or import files by clicking the plus sign @@ -102,7 +102,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -115,7 +115,7 @@ You can return from the document view to the document list with the back action * The logo Butterfly button, which opens the menu. * The Name field, which displays the name of the note. You can rename the note by typing a new name into the field and saving the note. * The Save button. You can enable auto-saving and optionally disable this button by going to Settings → Behaviors → Autosave. - * The Search button, which allow you to search for elements within the note. + * The Search button, which allows you to search for elements within the note. @@ -152,7 +152,7 @@ You can return from the document view to the document list with the back action * The [ Undo](tools/undo) and [ Redo](tools/redo) buttons * The [ Hand tool](tools/hand). - Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. + Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to lock the zoom and/or the position of the screen. If some of the elements on the toolbar are not visible to you, swipe left or right to reveal further tools. diff --git a/docs/src/content/docs/zh/docs/v2/layers.md b/docs/src/content/docs/zh/docs/v2/layers.md index c8963fe20224..893f85c72b03 100644 --- a/docs/src/content/docs/zh/docs/v2/layers.md +++ b/docs/src/content/docs/zh/docs/v2/layers.md @@ -8,7 +8,7 @@ Layers are drawn from bottom to top, so the top layer will be shown above all ot :::note\[Note] -Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are renderered. +Be aware that [Collections](../tools/collection) are not the same as layers. Collections are a lightweight way to group elements, but do not affect the order in which they are rendered. ::: diff --git a/docs/src/content/docs/zh/docs/v2/pack.md b/docs/src/content/docs/zh/docs/v2/pack.md index c376cacb1ee5..c767aa521338 100644 --- a/docs/src/content/docs/zh/docs/v2/pack.md +++ b/docs/src/content/docs/zh/docs/v2/pack.md @@ -2,7 +2,7 @@ title: 包 --- -A pack is a collection of components that can be used in the stamp tool. 您可以创建您自己的包或导入现有包。 点击左上角，然后点击"包"。 +A pack is a collection of components that can be used in the stamp tool. 您可以创建您自己的包或导入现有包。 To do this, click the top-left corner and select "Packs". Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document. @@ -31,7 +31,7 @@ To add a component: 4. Choose the pack 5. Give a name to the new component, it can be anything. -You can use these components using the [stamp tool](/docs/v2/pack) +You can use these components with the [stamp tool](/docs/v2/pack). ## Styles @@ -39,5 +39,4 @@ Styles are used to customize the appearance of the text. The paragraph styles ca ## Palettes -The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker. - +The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (as mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color. diff --git a/docs/src/content/docs/zh/docs/v2/pages.md b/docs/src/content/docs/zh/docs/v2/pages.md index 725f713be106..94ba66e13ec3 100644 --- a/docs/src/content/docs/zh/docs/v2/pages.md +++ b/docs/src/content/docs/zh/docs/v2/pages.md @@ -2,7 +2,7 @@ title: 页 次 --- -Pages are a way to organize your notes by allowing separate infinte canvases to be contained in a single document. +Pages are a way to organize your notes by allowing separate infinite canvases to be contained in a single document. :::note diff --git a/docs/src/content/docs/zh/docs/v2/shortcuts.md b/docs/src/content/docs/zh/docs/v2/shortcuts.md index 03f5ba83547b..9dd0aa09184f 100644 --- a/docs/src/content/docs/zh/docs/v2/shortcuts.md +++ b/docs/src/content/docs/zh/docs/v2/shortcuts.md @@ -34,7 +34,7 @@ title: 快捷键 ## 笔 -默认情况下，钢笔配置为如下功能： +By default, the pen is configured to function as the following: - “Pen\`：被配置为笔”。 - `First` (主按钮，如果支持的话)：按住时更改为手工具。 diff --git a/docs/src/content/docs/zh/docs/v2/storage.md b/docs/src/content/docs/zh/docs/v2/storage.md index 1138d9ff9c15..1f47bf22d7ae 100644 --- a/docs/src/content/docs/zh/docs/v2/storage.md +++ b/docs/src/content/docs/zh/docs/v2/storage.md @@ -8,8 +8,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## 数据目录 -数据目录是存储文档、模板和包的目录。 -在桌面上你可以在 "~/Documents/Linwood/Butterfly" 中找到它。 +The data directory is the directory where documents, templates, and packs are stored. +On desktop you can find it in `~/Documents/Linwood/Butterfly`. 移动时，它在 `getExternalFilesDir(null)/Linwood/Butterfly` 中。 您也可以在“数据”下的设置中更改它。 @@ -22,7 +22,7 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## 原生平台 -默认情况下，应用程序在一个名为“Linwood/Butterfly”的子文件夹中保存您的文档文件夹中的数据。 保存第一个数据时创建此文件夹。 此文件夹可以在设置中更改。 +By default, the application saves the data in your documents folder in a subfolder called "Linwood/Butterfly". This folder is created when you save data for the first time. 此文件夹可以在设置中更改。 ## 远程存储 {#remote} @@ -32,12 +32,12 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ::: -应用程序可以保存到远程服务器。 如果您想要与其他人分享数据，或者如果您有多台计算机，这是有用的。 目前只支持 `WebDAV` 协议。 +The application data can be stored on a remote server. 如果您想要与其他人分享数据，或者如果您有多台计算机，这是有用的。 目前只支持 `WebDAV` 协议。 若要添加远程服务器，请前往设置并点击 "Remotes" 。 然后点击"添加远程"。 添加远程服务器的 URL 以及用户名和密码。 之后您可以指定存储数据的文件夹。 -若要获取 webdav url，请访问文档： +To get the WebDAV URL, please visit the documentation: - [Nextcloud](https://docs.nextcloud.com/serverura/user_manual/en/files/access_webdav.html) (它看起来像这样：`https://nextcloud.example.com/remote.php/dav/files/username/`, 替换`username` 和 `nextcloud.example.com` @@ -55,8 +55,8 @@ Either by using your device storage, or by using the cloud storage (WebDAV). ## 其他存储方法 如果您在本地设备上，您也可以将应用程序目录与您最喜欢的平台同步。 -Google 驱动器在窗口上有[官方应用](https://www.google.com/drive/download/)并且在游戏商店上有非官方应用。 -在 Linux 上，您也可以使用本地远程存储系统并将您的数据目录更改为这个或者添加一个新的外部存储，如果您点击添加连接按钮。 +Google Drive has [an official app](https://www.google.com/drive/download/) on Windows and there are unofficial ones on the Play Store. +On Linux you can also use the native remote storage system and change your data directory to this or add a new external storage if you click on the add connection button. ## Supported file types @@ -64,21 +64,21 @@ Butterfly supports importing SVG, Butterfly Note (.bfly), Butterfly Raw Note (.t ### Butterfly Note (.bfly) -This file type is the recommended for saving notes. +This file type is the recommended format for saving notes. It is a zip archive containing the information (mostly in JSON files) about the note. -These included JSON files aren't optimized for being human readable. +These included JSON files aren't optimized for human readability. ### Butterfly Raw Note (.tbfly) This file is recommended for use with version control software like git. -This file is **not** a zip archive, instead it is a _JSON_ file. -It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is **slower** than the normal Butterfly Note in loading speed. +This file is **not** a zip archive; instead it is a _JSON_ file. +It contains all the information about the note in a single JSON file that is optimized for being readable and nicely formatted. It is slower to load than the normal Butterfly Note. ### SVG This file type doesn't save information about the note! When this file is imported into Butterfly, it is treated as a single image. -Use this _ONLY_ when the note shouldn't be modified by butterfly. +Use this _ONLY_ when the note shouldn't be modified by Butterfly. diff --git a/docs/src/content/docs/zh/docs/v2/templates.md b/docs/src/content/docs/zh/docs/v2/templates.md index b4ed022503c9..d96c28c50c68 100644 --- a/docs/src/content/docs/zh/docs/v2/templates.md +++ b/docs/src/content/docs/zh/docs/v2/templates.md @@ -4,7 +4,7 @@ title: 模板 In Butterfly, templates are a helpful way to make a document a starting point for quick use. -For example, if you like having a highlighter tool and a dotted background when note taking, you can use templates to quickly apply the tools you need and the specific background you like. +For example, if you like having a highlighter tool and a dotted background when taking notes, you can use templates to quickly apply the tools you need and the specific background you like. ## What do templates store? @@ -21,12 +21,12 @@ They store everything a normal document does, including: ## How to make a template? -Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left then press templates. +Simply make a new note, then after configuring it to your needs, press the Butterfly icon at the top-left and then press Templates. -Press the "Create" button, and give it a name, keep directory empty unless you want to save the template somewhere specific. +Press the "Create" button and give it a name. Keep the directory empty unless you want to save the template somewhere specific. ## Where can I find more templates? Unfortunately, there is no specific place to share your templates. -But if you think you have made a cool template, feel free to share in Discord. +But if you think you have made a cool template, feel free to share it on Discord. diff --git a/docs/src/content/docs/zh/docs/v2/utilities.md b/docs/src/content/docs/zh/docs/v2/utilities.md index e3147b35f0a4..6b797be0a9cd 100644 --- a/docs/src/content/docs/zh/docs/v2/utilities.md +++ b/docs/src/content/docs/zh/docs/v2/utilities.md @@ -16,7 +16,7 @@ Some features have recently moved to different locations. Please visit their pag ## 文件 -Here are all globally properties that you can set like description and encryption settings. +Here are all global properties that you can set, like description and encryption settings. Additionally, you can capture a thumbnail from the current viewport to see it in the home page. ## 摄像头 diff --git a/docs/src/content/docs/zh/downloads/web.mdx b/docs/src/content/docs/zh/downloads/web.mdx index b95930619566..54789da9e6f9 100644 --- a/docs/src/content/docs/zh/downloads/web.mdx +++ b/docs/src/content/docs/zh/downloads/web.mdx @@ -13,6 +13,8 @@ import DownloadButton from '/src/components/DownloadButton.astro'; 这是一个渐进的网络应用程序。 您可以在浏览器上安装并离线使用。 所有数据都保存在您的浏览器中。 +The web version works on all modern browsers, but is more performant on Chromium-based browsers due to their support for WebAssembly (Wasm). Firefox and Safari currently do not support the specific Wasm features required. See [Flutter's browser compatibility documentation](https://docs.flutter.dev/platform-integration/web/wasm#learn-more-about-browser-compatibility) for more details. + ::: ## 链接 diff --git a/docs/src/translations/af.json b/docs/src/translations/af.json index 3d3bbb4c36dd..9d5dc34f5868 100644 --- a/docs/src/translations/af.json +++ b/docs/src/translations/af.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Nagteliks", "privacy_policy": "Privaatheidsbeleid", diff --git a/docs/src/translations/ar.json b/docs/src/translations/ar.json index 74469b32fded..c84f26ef1c86 100644 --- a/docs/src/translations/ar.json +++ b/docs/src/translations/ar.json @@ -43,6 +43,7 @@ "code_of_conduct": "مدونة قواعد السلوك", "embedding": "Embedding", "faq": "أسئلة متكررة", + "stylus_support": "Stylus support", "versions": "الإصدارات", "nightly": "ليلي", "privacy_policy": "سياسة الخصوصية", diff --git a/docs/src/translations/ca.json b/docs/src/translations/ca.json index 0be5f6de221f..7d0c24c233a4 100644 --- a/docs/src/translations/ca.json +++ b/docs/src/translations/ca.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Nightly", "privacy_policy": "Política de privacitat", diff --git a/docs/src/translations/cs.json b/docs/src/translations/cs.json index e61b4eabee24..131f631f2774 100644 --- a/docs/src/translations/cs.json +++ b/docs/src/translations/cs.json @@ -43,6 +43,7 @@ "code_of_conduct": "Kodex chování", "embedding": "Embedding", "faq": "Nejčastější dotazy", + "stylus_support": "Stylus support", "versions": "Verze", "nightly": "Noční", "privacy_policy": "Zásady ochrany soukromí", diff --git a/docs/src/translations/da.json b/docs/src/translations/da.json index 1b6d1a0a374d..eb4269b2a4dd 100644 --- a/docs/src/translations/da.json +++ b/docs/src/translations/da.json @@ -43,6 +43,7 @@ "code_of_conduct": "Adfærdskodeks", "embedding": "Embedding", "faq": "OSS", + "stylus_support": "Stylus support", "versions": "Versioner", "nightly": "Natligt", "privacy_policy": "Privatliv politik", diff --git a/docs/src/translations/de.json b/docs/src/translations/de.json index cf115a01bf69..fdda2299f176 100644 --- a/docs/src/translations/de.json +++ b/docs/src/translations/de.json @@ -43,6 +43,7 @@ "code_of_conduct": "Verhaltenskodex", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versionen", "nightly": "Nightly", "privacy_policy": "Datenschutzerklärung", diff --git a/docs/src/translations/el.json b/docs/src/translations/el.json index 555ac2d0d584..7daf4effee6d 100644 --- a/docs/src/translations/el.json +++ b/docs/src/translations/el.json @@ -43,6 +43,7 @@ "code_of_conduct": "Κώδικας συμπεριφοράς", "embedding": "Embedding", "faq": "Συχνές", + "stylus_support": "Stylus support", "versions": "Εκδόσεις", "nightly": "Νυχτερινή", "privacy_policy": "Πολιτική απορρήτου", diff --git a/docs/src/translations/es.json b/docs/src/translations/es.json index 33e558f39fa3..95dc9a0ec483 100644 --- a/docs/src/translations/es.json +++ b/docs/src/translations/es.json @@ -43,6 +43,7 @@ "code_of_conduct": "Código de conducta", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versiones", "nightly": "Noche", "privacy_policy": "Política de privacidad", diff --git a/docs/src/translations/fi.json b/docs/src/translations/fi.json index 063ecb3cd760..83152f676b30 100644 --- a/docs/src/translations/fi.json +++ b/docs/src/translations/fi.json @@ -43,6 +43,7 @@ "code_of_conduct": "Käytännesäännöt ja -säännöt", "embedding": "Embedding", "faq": "UKK", + "stylus_support": "Stylus support", "versions": "Versiot", "nightly": "Yöllä", "privacy_policy": "Yksityisyyden suoja", diff --git a/docs/src/translations/fr.json b/docs/src/translations/fr.json index 067a785fc2d4..2115c7b30f4c 100644 --- a/docs/src/translations/fr.json +++ b/docs/src/translations/fr.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code de conduite", "embedding": "Embedding", "faq": "Foire Aux Questions", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Nuit", "privacy_policy": "Politique de confidentialité", diff --git a/docs/src/translations/he.json b/docs/src/translations/he.json index 63cda5186a9d..2e2ce30559c4 100644 --- a/docs/src/translations/he.json +++ b/docs/src/translations/he.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "לילי", "privacy_policy": "מדיניות פרטיות", diff --git a/docs/src/translations/hi.json b/docs/src/translations/hi.json index 3464c673e1c8..e40a7ebc7416 100644 --- a/docs/src/translations/hi.json +++ b/docs/src/translations/hi.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "नाइटली", "privacy_policy": "गोपनीयता नीति", diff --git a/docs/src/translations/hu.json b/docs/src/translations/hu.json index 7d17262b87ff..b69cf0f70c55 100644 --- a/docs/src/translations/hu.json +++ b/docs/src/translations/hu.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Éjszakai", "privacy_policy": "Adatvédelmi nyilatkozat", diff --git a/docs/src/translations/id.json b/docs/src/translations/id.json index 4f53e030687c..ce0f6c06c23e 100644 --- a/docs/src/translations/id.json +++ b/docs/src/translations/id.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Nightly", "privacy_policy": "Kebijakan Privasi ", diff --git a/docs/src/translations/it.json b/docs/src/translations/it.json index cd918e940550..c1e887c0b3d1 100644 --- a/docs/src/translations/it.json +++ b/docs/src/translations/it.json @@ -43,6 +43,7 @@ "code_of_conduct": "Codice di condotta", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versioni", "nightly": "Notte", "privacy_policy": "Informativa privacy", diff --git a/docs/src/translations/ja.json b/docs/src/translations/ja.json index 81c4fb203214..318849f5b20a 100644 --- a/docs/src/translations/ja.json +++ b/docs/src/translations/ja.json @@ -43,6 +43,7 @@ "code_of_conduct": "行動基準", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "バージョン", "nightly": "ナイトリー", "privacy_policy": "プライバシーポリシー", diff --git a/docs/src/translations/ko.json b/docs/src/translations/ko.json index 26a27de58de5..1d3a36da6c22 100644 --- a/docs/src/translations/ko.json +++ b/docs/src/translations/ko.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "나이틀리", "privacy_policy": "개인정보처리방침", diff --git a/docs/src/translations/nl.json b/docs/src/translations/nl.json index 110ee45ce6cb..4fcff6feb968 100644 --- a/docs/src/translations/nl.json +++ b/docs/src/translations/nl.json @@ -43,6 +43,7 @@ "code_of_conduct": "Gedragscode", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "versies", "nightly": "Nachtelijk", "privacy_policy": "Privacy Beleid", diff --git a/docs/src/translations/no.json b/docs/src/translations/no.json index da204b1cc16b..110f1baa1c04 100644 --- a/docs/src/translations/no.json +++ b/docs/src/translations/no.json @@ -43,6 +43,7 @@ "code_of_conduct": "Etiske retningslinjer", "embedding": "Embedding", "faq": "OSS", + "stylus_support": "Stylus support", "versions": "Versjoner", "nightly": "Nattlig", "privacy_policy": "Retningslinjer for personvern", diff --git a/docs/src/translations/or.json b/docs/src/translations/or.json index 673095fee832..9eda0df6dcaa 100644 --- a/docs/src/translations/or.json +++ b/docs/src/translations/or.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "ନିଶିତଳ", "privacy_policy": "ଗୋପନୀୟତା ନୀତି", diff --git a/docs/src/translations/pl.json b/docs/src/translations/pl.json index 9072049785f4..22c41149dd11 100644 --- a/docs/src/translations/pl.json +++ b/docs/src/translations/pl.json @@ -43,6 +43,7 @@ "code_of_conduct": "Kodeks postępowania", "embedding": "Embedding", "faq": "Często zadawane pytania", + "stylus_support": "Stylus support", "versions": "Wersje", "nightly": "Nocny", "privacy_policy": "Polityka prywatności", diff --git a/docs/src/translations/pt-br.json b/docs/src/translations/pt-br.json index 42ff7a7b50c6..0c81360477cc 100644 --- a/docs/src/translations/pt-br.json +++ b/docs/src/translations/pt-br.json @@ -43,6 +43,7 @@ "code_of_conduct": "Código de conduta", "embedding": "Embedding", "faq": "Perguntas Frequentes", + "stylus_support": "Stylus support", "versions": "Versões", "nightly": "Noturno", "privacy_policy": "Política de privacidade", diff --git a/docs/src/translations/pt.json b/docs/src/translations/pt.json index c843536d6ece..e1beb914bb72 100644 --- a/docs/src/translations/pt.json +++ b/docs/src/translations/pt.json @@ -43,6 +43,7 @@ "code_of_conduct": "Código de conduta", "embedding": "Embedding", "faq": "Perguntas Frequentes", + "stylus_support": "Stylus support", "versions": "Versões", "nightly": "Noturna", "privacy_policy": "Política de privacidade", diff --git a/docs/src/translations/ro.json b/docs/src/translations/ro.json index ab0ca7ab79a7..5129966bd0bc 100644 --- a/docs/src/translations/ro.json +++ b/docs/src/translations/ro.json @@ -43,6 +43,7 @@ "code_of_conduct": "Codul de conduită", "embedding": "Embedding", "faq": "Întrebări", + "stylus_support": "Stylus support", "versions": "Versiuni", "nightly": "Noptez", "privacy_policy": "Politica de confidenţialitate", diff --git a/docs/src/translations/ru.json b/docs/src/translations/ru.json index 6d6b21c2b505..000290cc82e6 100644 --- a/docs/src/translations/ru.json +++ b/docs/src/translations/ru.json @@ -43,6 +43,7 @@ "code_of_conduct": "Кодекс поведения", "embedding": "Embedding", "faq": "ЧАВО", + "stylus_support": "Stylus support", "versions": "Версии", "nightly": "Ночной", "privacy_policy": "Политика конфиденциальности", diff --git a/docs/src/translations/sr.json b/docs/src/translations/sr.json index 860b30d88f8e..6edc26e8ea73 100644 --- a/docs/src/translations/sr.json +++ b/docs/src/translations/sr.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Noćno", "privacy_policy": "Politika privatnosti", diff --git a/docs/src/translations/sv.json b/docs/src/translations/sv.json index 13944aff3dad..e3f66cb3261a 100644 --- a/docs/src/translations/sv.json +++ b/docs/src/translations/sv.json @@ -43,6 +43,7 @@ "code_of_conduct": "Uppförandekod", "embedding": "Embedding", "faq": "Vanliga frågor", + "stylus_support": "Stylus support", "versions": "Versioner", "nightly": "Nattlig", "privacy_policy": "Integritetspolicy", diff --git a/docs/src/translations/th.json b/docs/src/translations/th.json index 0d650b7e5bdc..aac9af59b4b1 100644 --- a/docs/src/translations/th.json +++ b/docs/src/translations/th.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "รุ่นรายคืน", "privacy_policy": "นโยบายความเป็นส่วนตัว", diff --git a/docs/src/translations/tr.json b/docs/src/translations/tr.json index 6c879a3967d5..f870fac4cb82 100644 --- a/docs/src/translations/tr.json +++ b/docs/src/translations/tr.json @@ -43,6 +43,7 @@ "code_of_conduct": "Davranış kuralları", "embedding": "Yerleştirme", "faq": "S.S.S.", + "stylus_support": "Stylus support", "versions": "Sürümler", "nightly": "Nightly", "privacy_policy": "Gizlilik politikası", diff --git a/docs/src/translations/uk.json b/docs/src/translations/uk.json index b123189e69e8..17c3a6b748f4 100644 --- a/docs/src/translations/uk.json +++ b/docs/src/translations/uk.json @@ -43,6 +43,7 @@ "code_of_conduct": "Кодекс поведінки", "embedding": "Embedding", "faq": "ЧАП", + "stylus_support": "Stylus support", "versions": "Версії", "nightly": "Нічна", "privacy_policy": "Політика конфіденційності", diff --git a/docs/src/translations/vi.json b/docs/src/translations/vi.json index cf79be62f143..e0b8a77cf129 100644 --- a/docs/src/translations/vi.json +++ b/docs/src/translations/vi.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "Embedding", "faq": "Câu hỏi thường gặp", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "Nightly", "privacy_policy": "Chính sách bảo mật", diff --git a/docs/src/translations/zh-hant.json b/docs/src/translations/zh-hant.json index 734132bf7bea..5725d30d2338 100644 --- a/docs/src/translations/zh-hant.json +++ b/docs/src/translations/zh-hant.json @@ -43,6 +43,7 @@ "code_of_conduct": "Code of conduct", "embedding": "嵌入", "faq": "FAQ", + "stylus_support": "Stylus support", "versions": "Versions", "nightly": "預覽版", "privacy_policy": "隱私政策", diff --git a/docs/src/translations/zh.json b/docs/src/translations/zh.json index d6195648a93c..7e7a996f1819 100644 --- a/docs/src/translations/zh.json +++ b/docs/src/translations/zh.json @@ -43,6 +43,7 @@ "code_of_conduct": "行为守则", "embedding": "Embedding", "faq": "常见问题", + "stylus_support": "Stylus support", "versions": "版本", "nightly": "开发版", "privacy_policy": "隐私政策",