From 23631a7dc5ca9555ede017139da68a13d46bbab3 Mon Sep 17 00:00:00 2001 From: Marcus Schwemer Date: Wed, 30 Oct 2024 12:01:41 +0100 Subject: [PATCH 1/3] [TASK] Trigger docs rendering --- Documentation/Readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Readme.md b/Documentation/Readme.md index e345cfb41..e91bc6ada 100644 --- a/Documentation/Readme.md +++ b/Documentation/Readme.md @@ -9,7 +9,7 @@ This documentation helps ## What does powermail do? -Powermail is a powerful and – in addition – a very easy mailform +Powermail is a powerful and a very easy mailform extension with a wide range of tools and features for editors, admins and developers. Define your form in the backend with a few clicks and look at the final output in the frontend. From 2382f8914645c72d597ecd515753aabe50cdc53f Mon Sep 17 00:00:00 2001 From: Marcus Schwemer Date: Wed, 30 Oct 2024 12:09:23 +0100 Subject: [PATCH 2/3] Rename Readme.md for docs rendering --- Documentation/{Readme.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Documentation/{Readme.md => README.md} (100%) diff --git a/Documentation/Readme.md b/Documentation/README.md similarity index 100% rename from Documentation/Readme.md rename to Documentation/README.md From dc8009e1f30b8671b4d2abaf613e1f7ebeac40fe Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sat, 9 Nov 2024 08:54:13 +0100 Subject: [PATCH 3/3] [TASK] Make the docs render --- .../Changelog/{Readme.md => Index.md} | 2 +- Documentation/FAQ/{Readme.md => Index.md} | 0 .../ForAdministrators/BestPractice.md | 42 +++++++++---------- .../BestPractice/DynamicReceiver.md | 4 +- .../ForAdministrators/{Readme.md => Index.md} | 2 +- Documentation/ForAdministrators/Upgrade.md | 2 +- .../ForContributors/{Readme.md => Index.md} | 11 ++++- Documentation/ForDevelopers/Index.md | 17 ++++++++ Documentation/ForDevelopers/Readme.md | 17 -------- .../ForEditors/{Readme.md => Index.md} | 2 +- Documentation/{README.md => Index.md} | 22 +++++----- Documentation/Links/{Readme.md => Index.md} | 0 Documentation/Support/{Readme.md => Index.md} | 0 Documentation/guides.xml | 2 +- composer.json | 1 + 15 files changed, 66 insertions(+), 58 deletions(-) rename Documentation/Changelog/{Readme.md => Index.md} (99%) rename Documentation/FAQ/{Readme.md => Index.md} (100%) rename Documentation/ForAdministrators/{Readme.md => Index.md} (91%) rename Documentation/ForContributors/{Readme.md => Index.md} (89%) create mode 100644 Documentation/ForDevelopers/Index.md delete mode 100644 Documentation/ForDevelopers/Readme.md rename Documentation/ForEditors/{Readme.md => Index.md} (84%) rename Documentation/{README.md => Index.md} (80%) rename Documentation/Links/{Readme.md => Index.md} (100%) rename Documentation/Support/{Readme.md => Index.md} (100%) diff --git a/Documentation/Changelog/Readme.md b/Documentation/Changelog/Index.md similarity index 99% rename from Documentation/Changelog/Readme.md rename to Documentation/Changelog/Index.md index 32dec4c05..405118901 100644 --- a/Documentation/Changelog/Readme.md +++ b/Documentation/Changelog/Index.md @@ -2,7 +2,7 @@ **Note:** Breaking changes are marked with !!! -See [Upgrade instructions and breaking changes](/Documentation/Changelog/UpgradeInstructions.md) for some details on +See [Upgrade instructions and breaking changes](/Changelog/UpgradeInstructions.md) for some details on breaking changes and how to handle them | Version | Release Date | Description | diff --git a/Documentation/FAQ/Readme.md b/Documentation/FAQ/Index.md similarity index 100% rename from Documentation/FAQ/Readme.md rename to Documentation/FAQ/Index.md diff --git a/Documentation/ForAdministrators/BestPractice.md b/Documentation/ForAdministrators/BestPractice.md index 4fa61c887..e55433bba 100644 --- a/Documentation/ForAdministrators/BestPractice.md +++ b/Documentation/ForAdministrators/BestPractice.md @@ -2,24 +2,24 @@ This chapter show you some best practice how you can deal with your daily business together with powermail -* [Templates](/Documentation/ForAdministrators/BestPractice/Templates.md) -* [ChangingLabels](/Documentation/ForAdministrators/BestPractice/ChangingLabels.md) -* [PrefillField](/Documentation/ForAdministrators/BestPractice/PrefillField.md) -* [DynamicReceiver](/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md) -* [RemoveValuesFromPowermailAll](/Documentation/ForAdministrators/BestPractice/RemoveValuesFromPowermailAll.md) -* [ManipulateValuesFromPowermailAll](/Documentation/ForAdministrators/BestPractice/ManipulateValuesFromPowermailAll.md) -* [UniqueValues](/Documentation/ForAdministrators/BestPractice/UniqueValues.md) -* [SaveSession](/Documentation/ForAdministrators/BestPractice/SaveSession.md) -* [AjaxSubmit](/Documentation/ForAdministrators/BestPractice/AjaxSubmit.md) -* [FilterFormSelection](/Documentation/ForAdministrators/BestPractice/FilterFormSelection.md) -* [SetPidForNewForms](/Documentation/ForAdministrators/BestPractice/SetPidForNewForms.md) -* [DevelopmentContext](/Documentation/ForAdministrators/BestPractice/DevelopmentContext.md) -* [SpamPrevention](/Documentation/ForAdministrators/BestPractice/SpamPrevention.md) -* [PreventDuplicates](/Documentation/ForAdministrators/BestPractice/PreventDuplicates.md) -* [SavingValuesToThirdPartyTables](/Documentation/ForAdministrators/BestPractice/SavingValuesToThirdPartyTables.md) -* [SendingValuesToThirdPartySoftware](/Documentation/ForAdministrators/BestPractice/SendingValuesToThirdPartySoftware.md) -* [Debug](/Documentation/ForAdministrators/BestPractice/Debug.md) -* [MainTypoScript](/Documentation/ForAdministrators/BestPractice/MainTypoScript.md) -* [DateConverterUserFunc](/Documentation/ForAdministrators/BestPractice/DateConverterUserFunc.md) -* [TypoScriptConditions](/Documentation/ForAdministrators/BestPractice/TypoScriptConditions.md) -* [PasswordField](/Documentation/ForAdministrators/BestPractice/PasswordField.md) +* [Templates](/ForAdministrators/BestPractice/Templates.md) +* [ChangingLabels](/ForAdministrators/BestPractice/ChangingLabels.md) +* [PrefillField](/ForAdministrators/BestPractice/PrefillField.md) +* [DynamicReceiver](/ForAdministrators/BestPractice/DynamicReceiver.md) +* [RemoveValuesFromPowermailAll](/ForAdministrators/BestPractice/RemoveValuesFromPowermailAll.md) +* [ManipulateValuesFromPowermailAll](/ForAdministrators/BestPractice/ManipulateValuesFromPowermailAll.md) +* [UniqueValues](/ForAdministrators/BestPractice/UniqueValues.md) +* [SaveSession](/ForAdministrators/BestPractice/SaveSession.md) +* [AjaxSubmit](/ForAdministrators/BestPractice/AjaxSubmit.md) +* [FilterFormSelection](/ForAdministrators/BestPractice/FilterFormSelection.md) +* [SetPidForNewForms](/ForAdministrators/BestPractice/SetPidForNewForms.md) +* [DevelopmentContext](/ForAdministrators/BestPractice/DevelopmentContext.md) +* [SpamPrevention](/ForAdministrators/BestPractice/SpamPrevention.md) +* [PreventDuplicates](/ForAdministrators/BestPractice/PreventDuplicates.md) +* [SavingValuesToThirdPartyTables](/ForAdministrators/BestPractice/SavingValuesToThirdPartyTables.md) +* [SendingValuesToThirdPartySoftware](/ForAdministrators/BestPractice/SendingValuesToThirdPartySoftware.md) +* [Debug](/ForAdministrators/BestPractice/Debug.md) +* [MainTypoScript](/ForAdministrators/BestPractice/MainTypoScript.md) +* [DateConverterUserFunc](/ForAdministrators/BestPractice/DateConverterUserFunc.md) +* [TypoScriptConditions](/ForAdministrators/BestPractice/TypoScriptConditions.md) +* [PasswordField](/ForAdministrators/BestPractice/PasswordField.md) diff --git a/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md b/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md index 758de60b5..0ed8068a9 100644 --- a/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md +++ b/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md @@ -34,8 +34,8 @@ plugin.tx_powermail.settings.setup.receiver.predefinedReceiver { ### Dynamic example 1 In a bit more advanced example, we want to choose the receiver by a given value (e.g. of a select box). -If value 1 is given in a field with marker *{receiver}*, *receivera@domain.org* should be chosen -and if value 2 or something else is given, *receiverb@domain.org* should be chosen. +If value 1 is given in a field with marker `{receiver}`, `receivera@domain.org` should be chosen +and if value 2 or something else is given, `receiverb@domain.org` should be chosen. See following TypoScript setup example: ``` diff --git a/Documentation/ForAdministrators/Readme.md b/Documentation/ForAdministrators/Index.md similarity index 91% rename from Documentation/ForAdministrators/Readme.md rename to Documentation/ForAdministrators/Index.md index b8743a9f5..2a9ab6f98 100644 --- a/Documentation/ForAdministrators/Readme.md +++ b/Documentation/ForAdministrators/Index.md @@ -1,4 +1,4 @@ -# TYPO3 Extension powermail - Documentation - For administrators +# For administrators This chapter describes how you can install and configure powermail on your TYPO3 instance diff --git a/Documentation/ForAdministrators/Upgrade.md b/Documentation/ForAdministrators/Upgrade.md index fa55fa7bc..4eead0462 100644 --- a/Documentation/ForAdministrators/Upgrade.md +++ b/Documentation/ForAdministrators/Upgrade.md @@ -8,7 +8,7 @@ as possible. ## Upgrade Instructions -You find instructions for each major version. [Upgrade Instructions](/Documentation/Changelog/UpgradeInstructions.md) +You find instructions for each major version. [Upgrade Instructions](/Changelog/UpgradeInstructions.md) ## Any Upgrade diff --git a/Documentation/ForContributors/Readme.md b/Documentation/ForContributors/Index.md similarity index 89% rename from Documentation/ForContributors/Readme.md rename to Documentation/ForContributors/Index.md index e17344775..3eaf72f6c 100644 --- a/Documentation/ForContributors/Readme.md +++ b/Documentation/ForContributors/Index.md @@ -1,4 +1,4 @@ -# TYPO3 Extension powermail - Documentation for contributors +# For contributors If you want to contribute to the TYPO3 extension powermail, you are very welcome. @@ -54,7 +54,7 @@ ddev exec composer run test:php:phpstan:generate-baseline ## Behaviour tests -More information on running behaviour tests is available here: [Behaviour tests](../../Tests/Behavior/readme.md) +More information on running behaviour tests is available here: [Behaviour tests](https://github.com/in2code-de/powermail/tree/documentation-draft/Tests/Behavior/readme.md) ## Frontend Development @@ -71,3 +71,10 @@ There is a small build pipeline to build the assets. The artifacts are committed * `npm run build` will build the necessary files * `npm run watch` will watch the files and rebuild them on changes +## Render the Documentation + +You can render the documentation locally with + +```bash +composer render:docs +``` diff --git a/Documentation/ForDevelopers/Index.md b/Documentation/ForDevelopers/Index.md new file mode 100644 index 000000000..0ba8f94f3 --- /dev/null +++ b/Documentation/ForDevelopers/Index.md @@ -0,0 +1,17 @@ +# For developers + +Powermail can be extended in similar ways. If you want to execute something on a submit, look at the Finisher Classes. +If you want to add own spamshield methods, look in this chapter, etc... + +* [AddFinisherClasses](/ForDevelopers/AddFinisherClasses.md) +* [AddSpamshieldMethods](/ForDevelopers/AddSpamshieldMethods.md) +* [DisableSpamshield](/ForDevelopers/DisableSpamshield.md) +* [EventDispatcher](/ForDevelopers/EventDispatcher.md) +* [AddNewFields](/ForDevelopers/AddNewFields.md) +* [AddNewFieldProperties](/ForDevelopers/AddNewFieldProperties.md) +* [AddNewFlexFormProperties](/ForDevelopers/AddNewFlexFormProperties.md) +* [WriteOwnValidators](/ForDevelopers/WriteOwnValidators.md) +* [AddDataProcessors](/ForDevelopers/AddDataProcessors.md) +* [UserfuncsWithCobject](/ForDevelopers/UserfuncsWithCobject.md) +* [DatabaseModel](/ForDevelopers/DatabaseModel.md) +* [Local Development with Docker](/ForDevelopers/LocalDevelopment.md) diff --git a/Documentation/ForDevelopers/Readme.md b/Documentation/ForDevelopers/Readme.md deleted file mode 100644 index 9e51431c5..000000000 --- a/Documentation/ForDevelopers/Readme.md +++ /dev/null @@ -1,17 +0,0 @@ -# TYPO3 Extension powermail - Documentation - For developers - -Powermail can be extended in similar ways. If you want to execute something on a submit, look at the Finisher Classes. -If you want to add own spamshield methods, look in this chapter, etc... - -* [AddFinisherClasses](/Documentation/ForDevelopers/AddFinisherClasses.md) -* [AddSpamshieldMethods](/Documentation/ForDevelopers/AddSpamshieldMethods.md) -* [DisableSpamshield](/Documentation/ForDevelopers/DisableSpamshield.md) -* [EventDispatcher](/Documentation/ForDevelopers/EventDispatcher.md) -* [AddNewFields](/Documentation/ForDevelopers/AddNewFields.md) -* [AddNewFieldProperties](/Documentation/ForDevelopers/AddNewFieldProperties.md) -* [AddNewFlexFormProperties](/Documentation/ForDevelopers/AddNewFlexFormProperties.md) -* [WriteOwnValidators](/Documentation/ForDevelopers/WriteOwnValidators.md) -* [AddDataProcessors](/Documentation/ForDevelopers/AddDataProcessors.md) -* [UserfuncsWithCobject](/Documentation/ForDevelopers/UserfuncsWithCobject.md) -* [DatabaseModel](/Documentation/ForDevelopers/DatabaseModel.md) -* [Local Development with Docker](/Documentation/ForDevelopers/LocalDevelopment.md) diff --git a/Documentation/ForEditors/Readme.md b/Documentation/ForEditors/Index.md similarity index 84% rename from Documentation/ForEditors/Readme.md rename to Documentation/ForEditors/Index.md index daed757e3..fa30fce67 100644 --- a/Documentation/ForEditors/Readme.md +++ b/Documentation/ForEditors/Index.md @@ -1,4 +1,4 @@ -# TYPO3 Extension powermail - Documentation - For editors +# For editors This chapter describes how to work with powermail from the view of an editor. diff --git a/Documentation/README.md b/Documentation/Index.md similarity index 80% rename from Documentation/README.md rename to Documentation/Index.md index e91bc6ada..ea9a6a703 100644 --- a/Documentation/README.md +++ b/Documentation/Index.md @@ -86,14 +86,14 @@ See the reporting about the delivered mails (Form or Marketing Data Analyses are ## Documentation overview -* [Introduction](/Documentation/Readme.md) -* [Development Model](/Documentation/DevelopmentModel.md) -* [Documentation for editors](/Documentation/ForEditors/Readme.md) -* [Documentation for administrators](/Documentation/ForAdministrators/Readme.md) -* [Documentation for developers](/Documentation/ForDevelopers/Readme.md) -* [Documentation for contributors](/Documentation/ForContributors/Readme.md) -* [FAQ](/Documentation/FAQ/Readme.md) (with a lot of stuff and best practice) -* [Changelog](/Documentation/Changelog/Readme.md) -* [Upgrade Instructions](/Documentation/Changelog/UpgradeInstructions.md) -* [Support](/Documentation/Support/Readme.md) -* [Additional links](/Documentation/Links/Readme.md) +* [Introduction](/Index.md) +* [Development Model](/DevelopmentModel.md) +* [Documentation for editors](/ForEditors/Index.md) +* [Documentation for administrators](/ForAdministrators/Index.md) +* [Documentation for developers](/ForDevelopers/Index.md) +* [Documentation for contributors](/ForContributors/Index.md) +* [FAQ](/FAQ/Index.md) (with a lot of stuff and best practice) +* [Changelog](/Changelog/Index.md) +* [Upgrade Instructions](/Changelog/UpgradeInstructions.md) +* [Support](/Support/Index.md) +* [Additional links](/Links/Index.md) diff --git a/Documentation/Links/Readme.md b/Documentation/Links/Index.md similarity index 100% rename from Documentation/Links/Readme.md rename to Documentation/Links/Index.md diff --git a/Documentation/Support/Readme.md b/Documentation/Support/Index.md similarity index 100% rename from Documentation/Support/Readme.md rename to Documentation/Support/Index.md diff --git a/Documentation/guides.xml b/Documentation/guides.xml index 00989ccd0..8a87d70a7 100644 --- a/Documentation/guides.xml +++ b/Documentation/guides.xml @@ -4,7 +4,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.phpdoc.org/guides vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" input-format="md" - index-name="Readme" + index-name="Index" automatic-menu="true" >