From 99f49efa5c586e2bd05062c5f0cb2958f90fbed8 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Nov 2022 11:56:39 +0100 Subject: [PATCH 1/4] Document "christophwurst/nextcloud replacement" and "Disabled keyboard shortcuts" for 25 Signed-off-by: Joas Schilling --- .../app_upgrade_guide/upgrade_to_25.rst | 23 ++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst index e2c988b1a..938185eef 100644 --- a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst +++ b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst @@ -17,7 +17,7 @@ Make sure your ``appinfo/info.xml`` allows for Nextcloud 25. - + SCSS support removal ^^^^^^^^^^^^^^^^^^^^ @@ -28,12 +28,29 @@ See `Github issue `_. Front-end changes ----------------- -tbd +Disabled keyboard shortcuts +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A global option to disable keyboard shortcuts was added to the accessibility settings. +Since it heavily depends on the screenreader and tools that you use if Ctrl and/or Alt or other things are okay to use +or not and maintaining a more detailed list is too much effort, we went for a global on/off switch. Apps can use this +public javascript API call to determine whether the user used the opt-out: ``OCP.Accessibility.disableKeyboardShortcuts()``. +If that is the case, no additional shortcuts shall be registered by any app. Only ``space`` to toggle checkboxes and +``enter`` to submit the currently active buttons/links are okay to be used. +See `Github issue `_. Back-end changes ---------------- -tbd +christophwurst/nextcloud replaced +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The `christophwurst/nextcloud `_ composer package was replaced +with a now Nextcloud owned `nextcloud/ocp `_ package. The content is the +same and all older versions were generated, so you can transition right away no matter which versions you support. +We also have a GitHub Actions cron job template available at +`https://github.com/nextcloud/.github/blob/master/workflow-templates/update-nextcloud-ocp.yml `_ +which updates the packages every sunday, so you can make sure your app is still compatible with the latest OCP. Changed APIs ^^^^^^^^^^^^ From aebec30c82d9e2c76a1268eaa0b0bf69c288c5c9 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Nov 2022 12:26:36 +0100 Subject: [PATCH 2/4] Make upgrade docs more relevant Signed-off-by: Joas Schilling --- .../app_upgrade_guide/upgrade_to_25.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst index 938185eef..3609c5a2b 100644 --- a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst +++ b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst @@ -42,15 +42,12 @@ See `Github issue `_. Back-end changes ---------------- -christophwurst/nextcloud replaced -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +``christophwurst/nextcloud`` replaced +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The `christophwurst/nextcloud `_ composer package was replaced with a now Nextcloud owned `nextcloud/ocp `_ package. The content is the same and all older versions were generated, so you can transition right away no matter which versions you support. -We also have a GitHub Actions cron job template available at -`https://github.com/nextcloud/.github/blob/master/workflow-templates/update-nextcloud-ocp.yml `_ -which updates the packages every sunday, so you can make sure your app is still compatible with the latest OCP. Changed APIs ^^^^^^^^^^^^ From 52b418867fb5a10b18c40d065ac1fa1c1daa9d52 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Nov 2022 12:54:59 +0100 Subject: [PATCH 3/4] Add ref to front-end docs Signed-off-by: Joas Schilling --- .../app_upgrade_guide/upgrade_to_25.rst | 4 ++-- developer_manual/basics/front-end/js.rst | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst index 3609c5a2b..128ac405a 100644 --- a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst +++ b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_25.rst @@ -23,7 +23,7 @@ SCSS support removal With 25, we removed the support for scss files provided by apps. Please handle your own compilation, move to a vue app or move back to css. -See `Github issue `_. +See `Github issue #32060 `_. Front-end changes ----------------- @@ -37,7 +37,7 @@ or not and maintaining a more detailed list is too much effort, we went for a gl public javascript API call to determine whether the user used the opt-out: ``OCP.Accessibility.disableKeyboardShortcuts()``. If that is the case, no additional shortcuts shall be registered by any app. Only ``space`` to toggle checkboxes and ``enter`` to submit the currently active buttons/links are okay to be used. -See `Github issue `_. +See `Github issue #34081 `_ and :ref:`JavaScript Frontend documentation `. Back-end changes ---------------- diff --git a/developer_manual/basics/front-end/js.rst b/developer_manual/basics/front-end/js.rst index 17d69ec51..739617b62 100644 --- a/developer_manual/basics/front-end/js.rst +++ b/developer_manual/basics/front-end/js.rst @@ -150,6 +150,8 @@ function Now state will contain the provided state which you can use as any variable. It is as simple as that. +.. _basics_frontend_javascript_keyboard_shortcuts: + Keyboard shortcuts ------------------ From 669b04d4bb5ed1a875f88e04d2b6c42c5d25569b Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Nov 2022 12:57:29 +0100 Subject: [PATCH 4/4] Fix missing highlight Signed-off-by: Joas Schilling --- developer_manual/basics/front-end/js.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/developer_manual/basics/front-end/js.rst b/developer_manual/basics/front-end/js.rst index 739617b62..1251c66af 100644 --- a/developer_manual/basics/front-end/js.rst +++ b/developer_manual/basics/front-end/js.rst @@ -166,6 +166,6 @@ Nextcloud wide. You can check the setting with the following function which retu OCP.Accessibility.disableKeyboardShortcuts(); -If that is the case, no additional shortcuts shall be registered by any app. Only space -to toggle checkboxes and enter to submit the currently active buttons or links are okay, +If that is the case, no additional shortcuts shall be registered by any app. Only ``space`` +to toggle checkboxes and ``enter`` to submit the currently active buttons or links are okay, as any other shortcut might interfere with screenreaders and other accessibility tools.