Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
T
TypoScript-Forger
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
TYPO3
TypoScript-Forger
Commits
2e05c9cb
Commit
2e05c9cb
authored
9 years ago
by
damjan
Browse files
Options
Downloads
Patches
Plain Diff
[TASK] Small fixes in readme
parent
a150f2a2
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+16
-15
16 additions, 15 deletions
README.md
with
16 additions
and
15 deletions
README.md
+
16
−
15
View file @
2e05c9cb
...
...
@@ -4,7 +4,8 @@
SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project:
Use
`composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName`
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
...
...
@@ -13,17 +14,17 @@ The project can be installed by composer, or downloaded from git:
### A) Install by composer
Change into
`ProjectName`
direc
tory
TODO: Setup composer.json to install from git reposi
tory
TODO: Setup composer.json to install from git repository
Use
`composer require ...`
and
`composer update`
to install the package.
cd ProjectName
composer require ...
composer update
### B) Download from git
cd Packages/Application
git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
cd typo_script_backend
cd Packages/Application
git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
cd typo_script_backend
## Supply the necessary routes
...
...
@@ -33,7 +34,7 @@ Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`)
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.
The prefix
`
ts
`
in uriPattern:
`
ts/<SGalinski.TypoScriptReferenceFrontend>
`
has purpose to avoid the conflict.
<pre>
-
...
...
@@ -66,8 +67,6 @@ The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has
### In empty project Routes.yaml looks like this
Uri prefix can be added if needed.
<pre>
-
name: 'TypoScriptReferenceFrontend'
...
...
@@ -90,14 +89,16 @@ Uri prefix can be added if needed.
package: TYPO3.Flow
</pre>
Uri prefix can be added if needed.
## Configure view
To be able to integrate SGalinski.TypoScriptReferenceFrontend package with other packages
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.
Here is view configuration for integration with
`
WMDB.Forger
`
package.
ProjectName/Configuration/Views.yaml:
`
ProjectName/Configuration/Views.yaml
`
:
<pre>
-
...
...
@@ -119,4 +120,4 @@ All the data which is used by this package is provided by RESTful web service:
https://gitlab.sgalinski.de/typo3/TypoScript-Backend
If the service is not installed, follow it's readme to do so.
If the
web
service is not installed, follow it's readme to do so.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment