Skip to content

Commit f33c54a

Browse files
authored
Merge pull request #14 from PackageFactory/kickstarterDocumentationAdjustments
Adjust kickstarter documentation to consider new enum and component n…
2 parents 24ed25d + 57aeda1 commit f33c54a

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

Documentation/05_Kickstarter.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,15 @@ For more information on this pattern, have a look at this excellent article: htt
2525
### Example
2626

2727
```sh
28-
./flow component:kickstartenum --package-key=Vendor.Site \
29-
Headline \
28+
./flow component:kickstartenum \
29+
Vendor.Site:Headline \
3030
HeadlineLook string \
3131
--values=REGULAR,HERO
3232
```
3333

34+
> **Hint:** Components are namespaced, defaulting to "Component". The component name "Vendor.Site:Headline" thus will be evaluated as "Vendor.Site:Component.Headline".
35+
> Arbitrary other namespaces, including nested, are supported, like "Vendor.Site:MyNamespace.Headline" or "Vendor.Site:My.Namespace.Headline".
36+
3437
### What files are being created?
3538

3639
#### HeadlineLook.php
@@ -46,7 +49,7 @@ This is the central pseudo-enum class. It consists of:
4649

4750
```php
4851
<?php
49-
namespace Vendor\Site\Presentation\Headline;
52+
namespace Vendor\Site\Presentation\Component\Headline;
5053

5154
/*
5255
* This file is part of the Vendor.Site package.
@@ -127,7 +130,7 @@ The exception in this file will be thrown, when the pseudo-enum is initialized w
127130

128131
```php
129132
<?php
130-
namespace Vendor\Site\Presentation\Headline;
133+
namespace Vendor\Site\Presentation\Component\Headline;
131134

132135
/*
133136
* This file is part of the Vendor.Site package.
@@ -164,7 +167,7 @@ use Neos\Flow\Annotations as Flow;
164167
use Neos\Flow\I18n\Translator;
165168
use Neos\Neos\Service\DataSource\AbstractDataSource;
166169
use Neos\Eel\ProtectedContextAwareInterface;
167-
use Vendor\Site\Presentation\Headline\HeadlineLook;
170+
use Vendor\Site\Presentation\Component\Headline\HeadlineLook;
168171

169172
class HeadlineLookProvider extends AbstractDataSource implements ProtectedContextAwareInterface
170173
{
@@ -239,13 +242,15 @@ For type names, the following rules apply:
239242
> **Hint:** It is recommended to create all required values and sub-components beforehand, so the kickstarter can find and create proper `use`-statements for them.
240243

241244
```sh
242-
./flow component:kickstart --package-key=Vendor.Site --namespace=Component \
243-
Headline \
245+
./flow component:kickstart Vendor.Site:Headline \
244246
type:HeadlineType \
245247
look:HeadlineLook \
246248
content:string
247249
```
248250

251+
> **Hint:** Components are namespaced, defaulting to "Component". The component name "Vendor.Site:Headline" thus will be evaluated as "Vendor.Site:Component.Headline".
252+
> Arbitrary other namespaces, including nested, are supported, like "Vendor.Site:MyNamespace.Headline" or "Vendor.Site:My.Namespace.Headline".
253+
249254
### What files are being created?
250255

251256
#### Headline.fusion
@@ -283,7 +288,7 @@ This is the PHP interface of the PresentationObject. It consists of a getter for
283288

284289
```php
285290
<?php
286-
namespace Vendor\Site\Presentation\Headline;
291+
namespace Vendor\Site\Presentation\Component\Headline;
287292

288293
/*
289294
* This file is part of the Vendor.Site package.
@@ -307,7 +312,7 @@ This is the PresentationObject itself. It is a full implementation of the interf
307312

308313
```php
309314
<?php
310-
namespace Vendor\Site\Presentation\Headline;
315+
namespace Vendor\Site\Presentation\Component\Headline;
311316

312317
/*
313318
* This file is part of the Vendor.Site package.
@@ -360,7 +365,7 @@ This is an empty factory for the PresentationObject that is supposed to be used
360365

361366
```php
362367
<?php
363-
namespace Vendor\Site\Presentation\Headline;
368+
namespace Vendor\Site\Presentation\Component\Headline;
364369

365370
/*
366371
* This file is part of the Vendor.Site package.

0 commit comments

Comments
 (0)