Skip to content

Commit

Permalink
[TASK] Adjust wording for Site Package Builder (#467)
Browse files Browse the repository at this point in the history
* [TASK] Adjust wording for Site Package Builder

* Across the documentation we spell it
Site Package and Site Package Builder.
* Unify case of Site Package Builder, also no hyphens
* Remove unsupported TYPO3 versions from form, templates were already missing
* Use get.typo3.org/sitepackage as creator URL

Co-authored-by: Sarah McCarthy <[email protected]>
  • Loading branch information
linawolf and sarahmccarthy123 authored Nov 25, 2024
1 parent 902b207 commit 324a1a9
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ config {
removeDefaultJS = 0
admPanel = 1
prefixLocalAnchors = all
headerComment = build by sitepackagebuilder.com
headerComment = build by get.typo3.org/sitepackage
sendCacheHeaders = 1
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/**
* Created from sitepackagebuilder.com
* Created by get.typo3.org/sitepackage
*/
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ config {
removeDefaultJS = 0
admPanel = 1
prefixLocalAnchors = all
headerComment = build by sitepackagebuilder.com
headerComment = build by get.typo3.org/sitepackage
sendCacheHeaders = 1
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/**
* Created from sitepackagebuilder.com
* Created by get.typo3.org/sitepackage
*/
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ config {
removeDefaultJS = 0
admPanel = 1
prefixLocalAnchors = all
headerComment = build by sitepackagebuilder.com
headerComment = build by get.typo3.org/sitepackage
sendCacheHeaders = 1
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/**
* Created from sitepackagebuilder.com
* Created by get.typo3.org/sitepackage
*/
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ config:
removeDefaultJS: '0'
admPanel: '1'
prefixLocalAnchors: 'all'
headerComment: 'build by sitepackagebuilder.com'
headerComment: 'build by get.typo3.org/sitepackage'
sendCacheHeaders: '1'
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
/**
* Created from sitepackagebuilder.com
* Created by get.typo3.org/sitepackage
*/
6 changes: 3 additions & 3 deletions src/Form/SitepackageType.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
->add('typo3Version', ChoiceType::class, [
'label' => 'TYPO3 Version',
'choices' => [
'13.4 (Beta)' => 13.4,
'13.4' => 13.4,
'12.4' => 12.4,
'11.5' => 11.5,
'10.4' => 10.4,
Expand All @@ -61,15 +61,15 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
->add('title', TextType::class, [
'attr' => [
'autocomplete' => 'off',
'placeholder' => 'My Sitepackage',
'placeholder' => 'My Site Package',
],
])
->add('description', TextareaType::class, [
'required' => false,
'empty_data' => '',
'attr' => [
'autocomplete' => 'off',
'placeholder' => 'Optional description for the use of this sitepackage',
'placeholder' => 'Optional description for the use of this Site Package',
],
])
->add('repositoryUrl', TextType::class, [
Expand Down
2 changes: 1 addition & 1 deletion src/Menu/MenuBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public function mainDefault(array $options): ItemInterface
'sitepackage',
[
'route' => 'sitepackage_index',
'label' => 'Sitepackage',
'label' => 'Site Package',
]
);

Expand Down
2 changes: 1 addition & 1 deletion templates/sitepackage/edit.html.twig
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% extends '@Template/layout.html.twig' %}
{% block title %}Edit your TYPO3 Sitepackage configuration{% endblock %}
{% block title %}Edit your TYPO3 Site Package configuration{% endblock %}
{% block body %}

{% frame with { color: 'dark', height: 'small', center: true, indent: true, backgroundImage: asset("assets/Images/keyvisual.png") } %}
Expand Down
26 changes: 13 additions & 13 deletions templates/sitepackage/index.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,39 @@
{% block body %}

{% frame with { color: 'dark', height: 'small', center: true, indent: true, backgroundImage: asset("assets/Images/keyvisual.png") } %}
<h1>Sitepackage Builder</h1>
<h1>Site Package Builder</h1>
<p class="lead">
Sitepackage-Builder is your kickstarter for modern TYPO3 Theme development. Learn more about TYPO3 templating
or start your own template right now.
Site Package Builder is your kickstarter for modern TYPO3 Theme development. Learn more about TYPO3 templating
or kickstart your own template right now.
</p>
<p>
<a href="{{ path('sitepackage_new') }}" class="btn btn-lg btn-primary">Create Sitepackage</a>
<a href="{{ path('sitepackage_new') }}" class="btn btn-lg btn-primary">Create Site Package</a>
</p>
{% endframe %}

{% frame with { center: true, indent: true } %}
<h2>What is a Sitepackage?</h2>
<h2>What is a Site Package?</h2>
<p>
A Sitepackage is a <strong>TYPO3 Extension</strong> that containers all relevant configuration for a Website.
Having all configuration stored in a package keeps it protected from unauthorized access.
As Extension your Sitepackage will manage your dependencies to other Extensions and/or the TYPO3 Version.
This will ease your deployment and enables you to put the configuration of your Webiste under Version Control.
A site package is a <strong>TYPO3 extension</strong> that contains all the configuration for a website.
Having configuration stored in a package keeps it protected from unauthorized access.
Packaged as an extension, your site package will manage dependencies to other extensions and/or the TYPO3 version.
This will make deployment easier and enable you to put the configuration of your website under version control.
</p>
<p>
Learn more about the <strong>best practices</strong> recommended from the TYPO3 Core Team.
Learn more about <strong>best practices</strong> recommended by the TYPO3 Core Team.
</p>
<p>
<a href="https://docs.typo3.org/permalink/t3sitepackage:start" class="btn btn-primary" target="_blank">
Learn about Sitepackages
Learn about Site Packages
</a>
</p>
{% endframe %}

{% frame with { color: 'dark', layout: 'embedded', center: true, indent: true } %}
<h2>Start your own Sitepackage</h2>
<h2>Start your own Site Package</h2>
<p>
<a href="{{ path('sitepackage_new') }}" class="btn btn-primary">
Create Sitepackage
Create Site Package
</a>
</p>
{% endframe %}
Expand Down
7 changes: 4 additions & 3 deletions templates/sitepackage/new.html.twig
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{% extends '@Template/layout.html.twig' %}
{% block title %}Create your very own TYPO3 Sitepackage{% endblock %}
{% block title %}Create your very own TYPO3 Site Package{% endblock %}
{% block body %}

{% frame with { color: 'dark', height: 'small', center: true, indent: true, backgroundImage: asset("assets/Images/keyvisual.png") } %}
<h1>Create your very own Sitepackage</h1>
<h1>Create your very own Site Package</h1>
<p class="lead">
Awesome you made it here! Just a few more Information about your Project and your very own Sitepackage is ready to download.
Awesome - you made it here! We just need a bit more information about your project and then your very own site
package will be ready to download.
</p>
{% endframe %}

Expand Down
3 changes: 2 additions & 1 deletion templates/sitepackage/success.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
{% frame with { color: 'dark', height: 'small', center: true, indent: true, backgroundImage: asset("assets/Images/keyvisual.png") } %}
<h1>Congratulations!</h1>
<p class="lead">
We have sucessfully generated your sitepackage. You can now review the generated configuration below, or download the prepared sitepackage.
We have successfully generated your site package. You can review the generated configuration below, or
download your site package.
</p>
<a href="{{ path('sitepackage_download') }}" class="btn btn-lg btn-primary">
<span class="btn-text">Download</span>
Expand Down

0 comments on commit 324a1a9

Please sign in to comment.