Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #10

Merged
merged 4 commits into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 54 additions & 13 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
28 changes: 18 additions & 10 deletions Documentation/ChangeLog/Index.rst
Original file line number Diff line number Diff line change
@@ -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
46 changes: 29 additions & 17 deletions Documentation/Configuration/Index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt


.. _configuration:
.. _configuration:

=============
Configuration
Expand All @@ -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
----
Expand All @@ -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
--------
Expand All @@ -56,11 +46,33 @@ Example: max.mustermann
Set the username of the customer account of plesk.


.. _password:
.. _password:

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.
34 changes: 34 additions & 0 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -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
17 changes: 0 additions & 17 deletions Documentation/Includes.txt

This file was deleted.

73 changes: 29 additions & 44 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
@@ -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:
[email protected]
: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 <https://typo3.org/>`__.
:Author:
Stefan Froemken

:Email:
[email protected]

**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
Loading
Loading