From d4d5b76a9c7624b46c03af6698f79e55e2b9fe33 Mon Sep 17 00:00:00 2001 From: Stefan Froemken Date: Sat, 11 Jan 2025 21:42:38 +0100 Subject: [PATCH 1/4] Update documentation --- Documentation/ChangeLog/Index.rst | 28 +++++--- Documentation/Configuration/Index.rst | 46 ++++++++----- Documentation/Includes.rst.txt | 34 ++++++++++ Documentation/Includes.txt | 17 ----- Documentation/Index.rst | 73 ++++++++------------ Documentation/Installation/Index.rst | 54 ++++++++++----- Documentation/Introduction/Index.rst | 17 +++-- Documentation/KnownProblems/Index.rst | 4 +- Documentation/Settings.cfg | 95 --------------------------- Documentation/User/Index.rst | 12 ++-- Documentation/guides.xml | 20 ++++++ 11 files changed, 184 insertions(+), 216 deletions(-) create mode 100644 Documentation/Includes.rst.txt delete mode 100644 Documentation/Includes.txt delete mode 100644 Documentation/Settings.cfg create mode 100644 Documentation/guides.xml diff --git a/Documentation/ChangeLog/Index.rst b/Documentation/ChangeLog/Index.rst index 23f75b6..2956b7d 100644 --- a/Documentation/ChangeLog/Index.rst +++ b/Documentation/ChangeLog/Index.rst @@ -1,31 +1,39 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _changelog: +.. _changelog: ========= ChangeLog ========= +**Version 2.0.0** + +* Add TYPO3 12 compatibility +* Remove TYPO3 11 compatibility +* Remove TYPO3 10 compatibility +* Add PHP Information Widget +* Separate Server Information into its own widget + **Version 1.2.1** -- Set EXT:dashboard as requirement +* Set EXT:dashboard as requirement **Version 1.2.0** -- Add TYPO3 11 compatibility -- Remove PHP 7.2 and 7.3 compatibility -- Add PHP 8.0 and 8.1 compatibility -- Update Plesk SDK to version 1.1.2 +* Add TYPO3 11 compatibility +* Remove PHP 7.2 and 7.3 compatibility +* Add PHP 8.0 and 8.1 compatibility +* Update Plesk SDK to version 1.1.2 **Version 1.1.0** -- Button to Plesk will login customer automatically +* Button to Plesk will login customer automatically **Version 1.0.1** -- Add missing extension icon +* Add missing extension icon **Version 1.0.0** -- Initial upload +* Initial upload diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst index 43cc6bd..3d03d4c 100644 --- a/Documentation/Configuration/Index.rst +++ b/Documentation/Configuration/Index.rst @@ -1,7 +1,7 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _configuration: +.. _configuration: ============= Configuration @@ -15,18 +15,7 @@ password and click on "Configure extensions". Than choose "plesk_widget". -.. _diskUsageType: - -diskUsageType -------------- - -Example: % - -You have the possibility to show the disk usage in -percent, MegaByte or in GigaByte. - - -.. _host: +.. _host: host ---- @@ -37,16 +26,17 @@ Enter the host, where this extension can access the plesk system. In most cases your domain name (without scheme, path and port). -.. _port: +.. _port: port ---- + Default: 8443 Which port should this extension use to access the plesk system? -.. _username: +.. _username: username -------- @@ -56,7 +46,7 @@ Example: max.mustermann Set the username of the customer account of plesk. -.. _password: +.. _password: password -------- @@ -64,3 +54,25 @@ password Example: doNotUseThis Set the password to access the customer account of plesk. + +.. _diskUsageType: + +diskUsageType +------------- + +Example: % + +You have the possibility to show the disk usage in +percent, MegaByte or in GigaByte. + + +.. _domain: + +domain +------ + +Example: 124.example.com + +Without a domain the Plesk API will show information about the first retrieved +domain. To show the information about a specific domain you should set this +value to a domain name in your plesk hosting. diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt new file mode 100644 index 0000000..d3d2f19 --- /dev/null +++ b/Documentation/Includes.rst.txt @@ -0,0 +1,34 @@ +.. More information about this file: + https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt + +.. ---------- +.. text roles +.. ---------- + +.. role:: aspect(emphasis) +.. role:: bash(code) +.. role:: html(code) +.. role:: js(code) +.. role:: php(code) +.. role:: rst(code) +.. role:: sep(strong) +.. role:: sql(code) + +.. role:: tsconfig(code) + :class: typoscript + +.. role:: typoscript(code) +.. role:: xml(code) + :class: html + +.. role:: yaml(code) + +.. default-role:: code + +.. --------- +.. highlight +.. --------- + +.. By default, code blocks use PHP syntax highlighting + +.. highlight:: php diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt deleted file mode 100644 index d3f749a..0000000 --- a/Documentation/Includes.txt +++ /dev/null @@ -1,17 +0,0 @@ -.. This is 'Includes.txt'. It is included at the very top of each and - every ReST source file in THIS documentation project (= manual). - -.. role:: aspect (emphasis) -.. role:: html(code) -.. role:: js(code) -.. role:: php(code) -.. role:: sep (strong) -.. role:: sql(code) -.. role:: typoscript(code) -.. role:: yaml(code) - -.. role:: ts(typoscript) - :class: typoscript - -.. default-role:: code -.. highlight:: php diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 8350b5a..5d7c16f 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,61 +1,46 @@ -.. include:: Includes.txt +.. include:: /Includes.rst.txt -.. Every manual should have a start label for cross-referencing to -.. start page. Do not remove this! - -.. _start: +.. _start: ============ Plesk Widget ============ -.. only:: html - - :Classification: - plesk_widget - - :Version: - |release| - - :Language: - en - - :Description: - Manual covering TYPO3 extension plesk_widget - - :Keywords: - plesk, status, widget, dashboard - - :Copyright: - 2013-2022 +:Language: + en - :Author: - Stefan Froemken +:Version: + |release| - :Email: - froemken@gmail.com +:Description: + TYPO3 extension to show plesk information as widget on TYPO3 DashBoard - :License: - This document is published under the Open Publication License - available from http://www.opencontent.org/openpub/ +:Keywords: + plesk, widget, dashboard - :Rendered: - |today| +:Copyright: + 2021-2025 - The content of this document is related to TYPO3, - a GNU/GPL CMS/Framework available from `www.typo3.org `__. +:Author: + Stefan Froemken +:Email: + froemken@gmail.com - **Table of Contents** +:License: + This document is published under the Open Content License + available from http://www.opencontent.org/opl.shtml -.. toctree:: - :maxdepth: 3 +:Rendered: + |today| +.. toctree:: + :titlesonly: - Introduction/Index - User/Index - Configuration/Index - Installation/Index - KnownProblems/Index - ChangeLog/Index + Introduction/Index + User/Index + Configuration/Index + Installation/Index + KnownProblems/Index + ChangeLog/Index diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst index 198b385..0bae465 100644 --- a/Documentation/Installation/Index.rst +++ b/Documentation/Installation/Index.rst @@ -1,36 +1,58 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _installation: +.. _installation: ============ Installation ============ +Composer +======== -Installation Type -================= +If your TYPO3 installation works in composer mode, please execute following +command: +.. code-block:: bash -Composer --------- + composer req stefanfroemken/plesk-widget + vendor/bin/typo3 extension:setup --extension=plesk_widget + +If you work with DDEV please execute this command: + +.. code-block:: bash + + ddev composer req stefanfroemken/plesk-widget + ddev exec vendor/bin/typo3 extension:setup --extension=plesk_widget + +ExtensionManager +================ + +On non composer based TYPO3 installations you can install `plesk_widget` still +over the ExtensionManager: + +.. rst-class:: bignums -You can install `mysql_plesk` with following shell command: +1. Login -.. code-block:: bash + Login to backend of your TYPO3 installation as an administrator or system + maintainer. - composer req stefanfroemken/mysql-plesk +2. Open ExtensionManager + Click on `Extensions` from the left menu to open the ExtensionManager. -Extensionmanager ----------------- +3. Update Extensions -If you want to install `mysql_plesk` traditionally with Extensionmanager, follow these steps: + Choose `Get Extensions` from the upper selectbox and click on + the `Update now` button at the upper right. -#. Visit ExtensionManager +4. Install `plesk_widget` -#. Switch over to `Get Extensions` + Use the search field to find `plesk_widget`. Choose the `plesk_widget` line from + the search result and click on the cloud icon to install `plesk_widget`. -#. Search for `mysql_plesk` +Next step +========= -#. Install extension +:ref:`Configure plesk_widget `. diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index 1640fe0..b80e83b 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -1,14 +1,13 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _introduction: +.. _introduction: ============ Introduction ============ - -.. _what-it-does: +.. _what-it-does: What does it do? ================ @@ -16,8 +15,8 @@ What does it do? This extension delivers a widget for TYPO3 DashBoard to show various information of your configured Plesk account. -* Show current disk usage (%, MB or GB) -* Show owner -* Show some PHP information -* Show IP addresses -* Button to Plesk (auto-login). On failure, button will link to plesk login screen. +* Show current disk usage (%, MB or GB) +* Show owner +* Show some PHP information +* Show internal/external IP addresses +* Button to Plesk (auto-login). On failure, button will link to plesk login screen. diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst index b3f0407..75afff1 100644 --- a/Documentation/KnownProblems/Index.rst +++ b/Documentation/KnownProblems/Index.rst @@ -1,7 +1,7 @@ -.. include:: ../Includes.txt +.. include:: /Includes.rst.txt -.. _known-problems: +.. _known-problems: ============== Known Problems diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index a5dab29..0000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,95 +0,0 @@ -# ##### -# -# Settings.cfg - A TYPO3 Documentation Project's Configuration File -# Information about Settings.cfg: -# https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html#settings-cfg -# -# About Syntax: -# See https://docs.python.org/2/library/configparser.html -# -# Attention: -# Only " ;" can start an inline comment. -# This is: blank PLUS semicolon! -# -# ##### - -[general] - -# ................................................................................. -# ... (required) title (displayed in left sidebar (desktop) or top panel (mobile) -# ................................................................................. - -project = Plesk Widget - -# ................................................................................. -# ... (recommended) version, displayed next to title (desktop) and in + + + + + + + + From 68db4ca35af4e1a5ae08d91ea679b2d001eb07e1 Mon Sep 17 00:00:00 2001 From: Stefan Froemken Date: Sat, 11 Jan 2025 21:42:50 +0100 Subject: [PATCH 2/4] Update .editorconfig --- .editorconfig | 67 +++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 54 insertions(+), 13 deletions(-) diff --git a/.editorconfig b/.editorconfig index fe14340..72bdfe1 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,23 +1,64 @@ # EditorConfig is awesome: http://EditorConfig.org -# -# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig # top-most EditorConfig file -root = false +root = true -[{*.rst,*.rst.txt}] +# Unix-style newlines with a newline ending every file +[*] charset = utf-8 end_of_line = lf -insert_final_newline = true -trim_trailing_whitespace = true indent_style = space -indent_size = 3 - -# MD-Files -[*.md] -charset = utf-8 -end_of_line = lf +indent_size = 4 insert_final_newline = true trim_trailing_whitespace = true -indent_style = space + +# TS/JS-Files +[*.{ts,js,mjs}] +indent_size = 2 + +# JSON-Files +[*.json] +indent_style = tab + +# ReST-Files +[*.{rst,rst.txt}] indent_size = 4 +max_line_length = 80 + +# Markdown-Files +[*.md] +max_line_length = 80 + +# YAML-Files +[*.{yaml,yml}] +indent_size = 2 + +# NEON-Files +[*.neon] +indent_size = 2 +indent_style = tab + +# stylelint +[.stylelintrc] +indent_size = 2 + +# package.json +[package.json] +indent_size = 2 + +# TypoScript +[*.{typoscript,tsconfig}] +indent_size = 2 + +# XLF-Files +[*.xlf] +indent_style = tab + +# SQL-Files +[*.sql] +indent_style = tab +indent_size = 2 + +# .htaccess +[{_.htaccess,.htaccess}] +indent_style = tab From b28b76ce546f82936dfa67b0a53f5ca3e45ad2f9 Mon Sep 17 00:00:00 2001 From: Stefan Froemken Date: Sat, 11 Jan 2025 21:43:43 +0100 Subject: [PATCH 3/4] Remove TS overwriting widget template paths --- ext_typoscript_setup.typoscript | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 ext_typoscript_setup.typoscript diff --git a/ext_typoscript_setup.typoscript b/ext_typoscript_setup.typoscript deleted file mode 100644 index 0573962..0000000 --- a/ext_typoscript_setup.typoscript +++ /dev/null @@ -1,7 +0,0 @@ -module.tx_dashboard { - view { - templateRootPaths { - 1610659265 = EXT:plesk_widget/Resources/Private/Templates/Dashboard/ - } - } -} From 23cac6b67b41eaa21d94eea7f9a9b5cc85e8dea8 Mon Sep 17 00:00:00 2001 From: Stefan Froemken Date: Sat, 11 Jan 2025 21:44:05 +0100 Subject: [PATCH 4/4] Update version to 2.0.1 --- ext_emconf.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ext_emconf.php b/ext_emconf.php index d1a3757..4afb449 100644 --- a/ext_emconf.php +++ b/ext_emconf.php @@ -16,11 +16,11 @@ 'author_company' => '', 'state' => 'stable', 'clearCacheOnLoad' => 0, - 'version' => '2.0.0', + 'version' => '2.0.1', 'constraints' => [ 'depends' => [ - 'typo3' => '12.4.24', - 'dashboard' => '12.4.24', + 'typo3' => '12.4.24-12.4.99', + 'dashboard' => '12.4.24-12.4.99', ], 'conflicts' => [ ],