Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
SGalinski.TypoScriptReferenceFrontend
## Setup Notes
### Prerequisite
SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project:
Use `composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName`
You can use any project name you wish. If you already have Flow project, you can skip this step.
### Install
The project can be installed by composer, or downloaded from git:
#### A) Install by composer
Change into `ProjectName` directory
TODO: Setup composer.json to install from git repository
Use `composer require ...` and `composer update` to install the package.
#### B) Download from git
cd Packages/Application
git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
cd typo_script_backend
### Supply the necessary routes
Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`)
#### If you are using WMDB.Forger package in same project
It is important to include SGalinski.TypoScriptReferenceFrontend subRoutes before WMDB.ForgerSubroutes to avoid
route conflicts.
The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has purpose to avoid the conflict.
<pre>
-
name: 'TypoScriptReferenceFrontend'
uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>'
subRoutes:
SGalinski.TypoScriptReferenceFrontend:
package: SGalinski.TypoScriptReferenceFrontend
-
name: 'Forger'
uriPattern: '<WMDB.ForgerSubroutes>'
subRoutes:
WMDB.ForgerSubroutes:
package: WMDB.Forger
##
# Flow subroutes
#
-
name: 'Flow'
uriPattern: '<FlowSubroutes>'
defaults:
'@format': 'html'
subRoutes:
FlowSubroutes:
package: TYPO3.Flow
</pre>
#### In empty project Routes.yaml looks like this
Uri prefix can be added if needed.
<pre>
-
name: 'TypoScriptReferenceFrontend'
uriPattern: '<SGalinski.TypoScriptReferenceFrontend>'
subRoutes:
SGalinski.TypoScriptReferenceFrontend:
package: SGalinski.TypoScriptReferenceFrontend
##
# Flow subroutes
#
-
name: 'Flow'
uriPattern: '<FlowSubroutes>'
defaults:
'@format': 'html'
subRoutes:
FlowSubroutes:
package: TYPO3.Flow
</pre>
### Configure view
To be able to integrate SGalinski.TypoScriptReferenceFrontend package with other packages
(for example to use existing menu from other package), view configuration in main project is needed.
Here is view configuration for integration with WMDB.Forger package.
ProjectName/Configuration/Views.yaml:
-
options:
layoutRootPaths:
'WMDB.Forger/Layouts': 'resource://WMDB.Forger/Private/Layouts'
partialRootPaths:
'WMDB.Forger/Partials': 'resource://WMDB.Forger/Private/Partials'
'SGalinski.TypoScriptReferenceFrontend/Partials': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Partials'
# templateRootPaths:
# 'WMDB.Forger/Templates': 'resource://WMDB.Forger/Private/Templates'
# 'SGalinski.TypoScriptReferenceFrontend/Templates': 'resource://SGalinski.TypoScriptReferenceFrontend/Private/Templates'