Neos

https://neos.readthedocs.io/en/9.1/
Admin
Neos is a free enterprise web content management system licensed under the GPL, providing a modern...
Tokens:130,458
Snippets:1,768
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Sphinx using easy_install

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/Documentation.html

Install or upgrade Sphinx using easy_install. This is an alternative method for installing Sphinx.

```bash
easy_install -U sphinx
```

--------------------------------

### Install Git and Hub

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Commands to install Git and the Hub CLI tool on Debian-based and Arch Linux systems.

```bash
sudo apt-get install git-all hub #(Debian Based)
sudo pacman -Sy git hub #(Arch Linux)
```

--------------------------------

### DimensionsMenuItems Minimal Example

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Output a menu containing all configured dimension combinations.

```fusion
variantMenuItems = Neos.Neos:DimensionsMenuItems
```

--------------------------------

### Run Development Server

Source: https://neos.readthedocs.io/en/9.1/References/CommandReference.html

Starts the standalone development server with a specific Flow context.

```bash
export FLOW_CONTEXT=Development && ./flow server:run
```

--------------------------------

### Install Sphinx Packages

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Commands to install Sphinx and related themes into the user directory.

```bash
pip install --user sphinx
pip install --user sphinx-autobuild
pip install --user sphinx_rtd_theme
```

--------------------------------

### Configure MenuItems with custom starting point

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Set a specific node as the starting point for the menu hierarchy.

```fusion
menuItems = Neos.Neos:MenuItems {
        entryLevel = 2
        maximumLevels = 1
        startingPoint = ${q(site).children('[uriPathSegment="metamenu"]').get(0)}
}
```

--------------------------------

### Start local documentation server

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Run this command within the Documentation directory to launch a live-reloading documentation server.

```bash
make livehtml
```

--------------------------------

### Start documentation server with todo items enabled

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Launch the live-reloading server with the todo extension configured to display items in the rendered output.

```bash
make livehtml SPHINXOPTS="-D todo_include_todos=1"
```

--------------------------------

### Install Sphinx using pip

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/Documentation.html

Install or upgrade Sphinx using pip. This is a prerequisite for building Neos documentation locally.

```bash
pip install -U sphinx
```

--------------------------------

### DateTimeRangeValidator Configuration Examples

Source: https://neos.readthedocs.io/en/9.1/References/Validators/Flow.html

Examples of configuring earliestDate and latestDate boundaries using ISO 8601 duration formats.

```yaml
earliestDate: now/PT5M
```

```yaml
latestDate: P10D/now
```

```yaml
earliestDate: 2007-03-01T13:00:00Z latestDate: 2007-03-30T13:00:00Z
```

--------------------------------

### Install Atom Editor

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Command to install the Atom editor on Arch Linux.

```bash
yaourt atom-editor #(Arch Linux)
```

--------------------------------

### Format currency using inline notation

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Examples of using the ViewHelper with inline syntax and various configuration options.

```html
{someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: '€')}
```

```html
{someNumber -> f:format.currency(currencySign: '€', forceLocale: true)}
```

```html
{someNumber -> f:format.currency(currencySign: 'EUR', forceLocale: 'de_DE')}
```

```html
{someNumber -> f:format.currency(currencySign: '€', prependCurrency: 'true')}
```

```html
{someNumber -> f:format.currency(currencySign: '€', separateCurrency: 'false', decimals: '0')}
```

--------------------------------

### Test string start

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Checks if a string begins with a specific search string, optionally starting at a given position.

```text
String.startsWith('Hello world!', 'Hello') == true
String.startsWith('My hovercraft is full of...', 'Hello') == false
String.startsWith('My hovercraft is full of...', 'hovercraft', 3) == true
```

--------------------------------

### Install Python Pip

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Command to install python-pip on Arch Linux.

```bash
sudo pacman -S python-pip
```

--------------------------------

### Setup Content Repository Projection and Replay Subscription

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/911.html

Command to set up a new content repository projection and replay its subscription, useful for enabling new functionality like the trash bin projection.

```bash
./flow cr:setup ./flow subscription:replay Neos.Workspace.Ui:TrashBinProjection
```

--------------------------------

### Implement f:widget.autocomplete

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Usage example for the autocomplete widget and the required external library inclusions.

```html
<f:input id=”name” … /> <f:widget.autocomplete for=”name” objects=”{posts}” searchProperty=”author”> 
```

```html
<script type=”text/javascript” src=”http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js”></script> <script type=”text/javascript” src=”http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.4/jquery-ui.min.js”></script> <link rel=”stylesheet” href=”http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.3/themes/base/jquery-ui.css” type=”text/css” media=”all” /> <link rel=”stylesheet” href=”http://static.jquery.com/ui/css/demo-docs-theme/ui.theme.css” type=”text/css” media=”all” /> 
```

--------------------------------

### Example Nodetype for Raw Content Mode

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/840.html

This example nodetype demonstrates how to configure properties for raw content mode, including asset subtypes like Video, Document, and Audio, with specific UI and inspector settings.

```yaml
Neos.Demo:Content.Test:
  superTypes:
    'Neos.Neos:Content': true
    'Neos.Demo:Constraint.Content.Column': true
    'Neos.Demo:Constraint.Content.Main': true
  ui:
    label: Test
    icon: picture
    position: start
  inspector:
    groups:
      settings:
        label: Test Settings
  properties:
    video:
      type: Neos\Media\Domain\Model\Video
      ui:
        label: 'Video'
        reloadIfChanged: true
        showInCreationDialog: true
        inspector:
          group: 'settings'
          editor: Neos.Neos/Inspector/Editors/AssetEditor
    document:
      type: Neos\Media\Domain\Model\Document
      ui:
        label: Document
        inspector:
          group: 'settings'
          editor: Neos.Neos/Inspector/Editors/AssetEditor
    audio:
      type: Neos\Media\Domain\Model\Audio
      ui:
        label: Audio
        inspector:
          group: 'settings'
          editor: Neos.Neos/Inspector/Editors/AssetEditor

```

--------------------------------

### Configure Neos.Neos:Menu

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Basic setup for a navigation menu with custom attributes and depth limits.

```Fusion
menu = Neos.Neos:Menu {
  attributes.class = 'menu'
  maximumLevels = 3
}
```

--------------------------------

### Configure Additional Resources for All Backend Modules

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ReleaseNotes/830.html

Example of how to include additional stylesheets and JavaScript files for all backend modules simultaneously by configuring them in `Neos.Neos.moduleConfiguration.additionalResources`.

```yaml
Neos:
    
    moduleConfiguration:
    
        additionalResources:
    
            styleSheets:
    
                ‘My.Package’: ‘resource://My.Package/Public/JavaScript/Main.css’ 

            javaScripts:
    
                ‘My.Package’: ‘resource://My.Package/Public/JavaScript/Main.js’
```

--------------------------------

### Format values with f:format.printf

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/TYPO3Fluid.html

Examples demonstrating scientific notation, argument swapping, single arguments, and inline notation using the printf ViewHelper.

```html
<f:format.printf arguments="{number: 362525200}">%.3e</f:format.printf>
```

```html
<f:format.printf arguments="{0: 3, 1: 'Kasper'}">%2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s!</f:format.printf>
```

```html
<f:format.printf arguments="{1: 'TYPO3'}">We love %s</f:format.printf>
```

```html
{someText -> f:format.printf(arguments: {1: 'TYPO3'})}
```

--------------------------------

### String.substr(string, start, length)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Returns the characters in a string from start up to the given length.

```APIDOC
## String.substr(string, start, length)

### Description
Return the characters in a string from start up to the given length. This implementation follows the JavaScript specification for “substr”.

### Parameters
- **string** (string) - Required - A string
- **start** (integer) - Required - Start offset
- **length** (integer) - Optional - Maximum length of the substring that is returned

### Return
- **string** - The substring
```

--------------------------------

### PHP Comparison Best Practices

Source: https://neos.readthedocs.io/en/9.1/References/CodingGuideLines/PHP.html

Examples of preferred strict comparisons versus discouraged truthy/falsy checks.

```php
if ($template)             // BAD
if (isset($template))      // GOOD
if ($template !== NULL))   // GOOD
if ($template !== ''))     // GOOD

if (strlen($template) > 0) // BAD! strlen("-1") is greater than 0
if (is_string($template) && strlen($template) > 0) // BETTER

if ($foo == $bar)          // BAD, avoid truthy comparisons
if ($foo != $bar)          // BAD, avoid falsy comparisons
if ($foo === $bar))        // GOOD
if ($foo !== $bar))        // GOOD
```

--------------------------------

### Link Editor Configuration Example

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/911.html

Configuration snippet showing legacy options for the inline link editor, which should be rewritten using the new `linkTypes` declaration.

```yaml
inline:
    editorOptions:
    linking:
  * anchor: true title: true relNofollow: true targetBlank: true
```

--------------------------------

### Configure LinkEditor with Node startingPoint

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/916.html

Use this configuration in the LinkEditor to correctly specify a starting point for the sites node.

```yaml
linking:
> 

linkTypes:
     

Node:
    
> startingPoint: ‘/<Neos.Neos:Sites>’
```

--------------------------------

### Configure basic MenuItems

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Define a menu starting at level 1 with a maximum depth of 3 levels.

```fusion
menuItems = Neos.Neos:MenuItems {
        entryLevel = 1
        maximumLevels = 3
}
```

--------------------------------

### Iterating with Neos.Fusion:Loop

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Examples of using Loop with either an object or an expression as the itemRenderer.

```Fusion
myLoop = Neos.Fusion:Loop {
        items = ${[1, 2, 3]}
        itemName = 'element'
        itemRenderer = Neos.Fusion:Template {
                templatePath = 'resource://...'
                element = ${element}
        }
}
```

```Fusion
myLoop = Neos.Fusion:Loop {
        items = ${[1, 2, 3]}
        itemName = 'element'
        itemRenderer = ${element * 2}
}
```

--------------------------------

### Create a Date object

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Use these examples to instantiate a DateTime object from a string or relative time format.

```eel
Date.create('2018-12-04')
Date.create('first day of next year')
```

--------------------------------

### Configure Inline Editor Options

Source: https://neos.readthedocs.io/en/9.1/References/NodeTypeDefinition.html

Example configuration for inline editing, including placeholder text, paragraph behavior, link attributes, and available text formatting options.

```yaml
inline:
  editorOptions:
    placeholder: i18n
    autoparagraph: true
    linking:
      title: true
      relNofollow: true
      targetBlank: true
    formatting:
      strong: true
      em: true
      sub: true
      sup: true
      p: true
      h1: true
      h2: true
      h3: true
      h4: true
      h5: true
      h6: true
      pre: true
      underline: true
      strikethrough: true
      removeFormat: true
      left: true
      right: true
      center: true
      justify: true
      table: true
      ol: true
      ul: true
      a: true
```

--------------------------------

### String.startsWith(string, search, position)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Tests if a string starts with the given search string.

```APIDOC
## String.startsWith(string, search, position)

### Description
Test if a string starts with the given search string.

### Parameters
- **string** (string) - Required - The input string
- **search** (string) - Required - The string to search for
- **position** (integer) - Optional - The position to test (defaults to the beginning of the string)

### Return
- **boolean**
```

--------------------------------

### Usable nodeTypes:show command with level option

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/840.html

Demonstrates the usage of the `nodeTypes:show` command with the new `level` option to clamp the input, making it more useful for larger nodetypes. It also shows an example of how to display NodeType configuration.

```bash
flow nodeTypes:show Neos.Demo:Document.Homepage –path properties –level 1
```

```yaml
NodeType configuration “Neos.Demo:Document.Homepage.properties”:
_removed: …
_creationDateTime: …
_lastModificationDateTime: …
_lastPublicationDateTime: …
_path: …
_name: …
_nodeType: …
_hidden: …
_hiddenBeforeDateTime: …
_hiddenAfterDateTime: …
titleOverride: …
metaDescription: …
…
```

--------------------------------

### Configure LinkEditor for a property

Source: https://neos.readthedocs.io/en/9.1/References/PropertyEditorReference.html

Basic setup for the LinkEditor within a node type definition, demonstrating how to reorder link types.

```yaml
Vendor.Site:LinkEditor:
  # ...
  properties:
    myLink:
      type: string
      ui:
        inspector:
          editor: 'Neos.Neos/Inspector/Editors/LinkEditor'
          editorOptions:
            linkTypes:
              Node:
                position: 'before Web'
```

--------------------------------

### Compare good and bad commit subject lines

Source: https://neos.readthedocs.io/en/9.1/References/CodingGuideLines/PHP.html

Examples demonstrating correct prefix usage, tense, and formatting for breaking changes in commit subjects.

```text
Introduce xyz service                               // BAD, missing code prefix
BUGFIX: Fixed bug xyz                               // BAD, subject should be written in present tense
WIP !!! TASK: A breaking change                     // BAD, subject has to start with [!!!] for breaking changes
BUGFIX: Make SessionManager remove expired sessions // GOOD, the line explains what the change does, not what the
                                                       bug is about (this should be explained in the following lines
                                                       and in the related bug tracker ticket)
```

--------------------------------

### Define the standard file header

Source: https://neos.readthedocs.io/en/9.1/References/CodingGuideLines/PHP.html

Every PHP file must start with a namespace declaration followed by a specific copyright and license header that does not use the docblock syntax.

```php
<?php
namespace YourCompany\Package\Something\New;

/*
 * This file is part of the YourCompany.Package package.
 *
 * (c) YourCompany
 *
 * This package is Open Source Software. For the full copyright and license
 * information, please view the LICENSE file which was distributed with this
 * source code.
 */
```

--------------------------------

### Configure module position in Neos backend

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ReleaseNotes/730.html

Allows customization of the position of backend modules by specifying their placement relative to other modules. This example shows how to place the media module after the workspaces module.

```yaml
Neos:
  Neos:
    modules:
      management:
        submodules:
          media:
            position: 'after workspaces'
```

--------------------------------

### Change Property Type to Backed Enum Configuration

Source: https://neos.readthedocs.io/en/9.1/References/NodeMigrations.html

Example configuration showing the transition from a scalar string property to a backed enum type.

```yaml
'Acme.Site:MyNodeType':
  properties:
    someValue:
      type: string
```

```yaml
'Acme.Site:MyNodeType':
  properties:
    someValue:
      type: Acme\Site\SomeStringEnum
```

--------------------------------

### Deprecate Fusion Namespaces - Alias example

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ReleaseNotes/730.html

Illustrates the deprecated method of aliasing Fusion namespaces. Starting with Neos 8, this syntax will no longer work and requires full namespace declaration.

```yaml
namespace: Foo = Acme.Demo
video = Foo:YouTube
```

--------------------------------

### YAML Configuration for Child Node Labels

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/911.html

Example of a YAML file defining content elements with child nodes, specifying their types and labels for translation.

```yaml
‘Neos.Demo:Content.Columns.Two’:
> … childNodes:
>> 

column0:
    
>> type: ‘Neos.Demo:Collection.Content.Column’ label: i18n 

column1:
    
>> type: ‘Neos.Demo:Collection.Content.Column’ label: i18n
```

--------------------------------

### Content Repository Performance Tracing Log Format

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/907.html

Example log output from the Content Repository performance tracer when enabled. This format helps in analyzing the performance of content repository operations.

```text
# PERFORMANCE TRACING (Local Debugging) # To enable Performance Tracing, comment-in the following lines:
# performanceTracer:
#     factoryObjectName: Neos\ContentRepository\Core\Infrastructure\Tracing\LogFileTracerFactory
#     options:
#         fileName: '%FLOW_PATH_DATA%Logs/ContentRepositoryProfile.log' # how long should a mark be at least, to be logged? if 0, everything is shown.
#         minimumMarkDurationMs: 1
```

--------------------------------

### View Makefile commands

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/Documentation.html

Navigate to the documentation directory and run 'make help' to see available commands for building the documentation.

```bash
cd Neos.Neos/Documentation
make help

```

--------------------------------

### Basic GET form usage

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Renders a form using the GET method.

```html
<f:form action="..." method="get">...</f:form>
```

```html
<form method="GET" action="...">...</form>
```

--------------------------------

### Format currency with all parameters

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Usage demonstrating custom currency sign, separators, and placement settings.

```html
<f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="false", separateCurrency="true", decimals="2">54321</f:format.currency>
```

--------------------------------

### String.substring(string, start, end)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Returns the characters in a string from a start index to an end index.

```APIDOC
## String.substring(string, start, end)

### Description
Return the characters in a string from a start index to an end index. This implementation follows the JavaScript specification for “substring”.

### Parameters
- **string** (string) - Required
- **start** (integer) - Required - Start index
- **end** (integer) - Optional - End index

### Return
- **string** - The substring
```

--------------------------------

### Default f:uri.action usage

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Demonstrates the basic usage of the ViewHelper using current package and controller defaults.

```html
<f:uri.action>some link</f:uri.action>
```

--------------------------------

### Array.range(start, end, step)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Creates an array containing a range of elements from start to end.

```APIDOC
## Array.range(start, end, step)

### Description
Create an array containing a range of elements. If a step value is given, it will be used as the increment between elements.

### Parameters
- **start** (mixed) - Required - First value of the sequence.
- **end** (mixed) - Required - The sequence is ended upon reaching the end value.
- **step** (int) - Optional - The increment between items, defaults to 1.

### Return
- **array** - Array of elements from start to end, inclusive.
```

--------------------------------

### f:uri.action with additional arguments

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Demonstrates specifying target controller, action, package, and custom query arguments.

```html
<f:uri.action action="myAction" controller="MyController" package="YourCompanyName.MyPackage" subpackage="YourCompanyName.MySubpackage" arguments="{key1: 'value1', key2: 'value2'}">some link</f:uri.action>
```

--------------------------------

### Show Help for Specific Command

Source: https://neos.readthedocs.io/en/9.1/Operations/CommandLine.html

Displays detailed usage information, arguments, options, and description for a specific command, such as 'neos.neos:user:addrole'.

```bash
./flow help user:addrole

Add a role to a user

COMMAND:
  neos.neos:user:addrole

USAGE:
  ./flow user:addrole [<options>] <username> <role>

ARGUMENTS:
  --username           The username of the user
  --role               Role to be added to the user, for example
                       "Neos.Neos:Administrator" or just "Administrator

OPTIONS:
  --authentication-provider Name of the authentication provider to use. Example:
                       "Neos.Neos:Backend

DESCRIPTION:
  This command allows for adding a specific role to an existing user.

  Roles can optionally be specified as a comma separated list. For all roles provided by Neos, the role
  namespace "Neos.Neos:" can be omitted.

  If an authentication provider was specified, the user will be determined by an account identified by "username"
  related to the given provider. However, once a user has been found, the new role will be added to all
  existing accounts related to that user, regardless of its authentication provider.

```

--------------------------------

### Array.length

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Gets the length of an array.

```APIDOC
## Array.length(array)

### Description
Get the length of an array.

### Parameters
- **array** (iterable) - Required - The array

### Return
- **int**
```

--------------------------------

### Render Link.Action in Fusion and AFX

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Demonstrates creating links to controller actions using both standard Fusion syntax and AFX.

```fusion
link = Neos.Fusion:Link.Action {
        content = "register"
        class="action-link"
        href.package = 'My.Package'
        href.controller = 'Registration'
        href.action = 'new'
}

link = afx`
        <Neos.Fusion:Link.Action class="action-link" href.package="My.Package" href.controller="Registration" href.action="new">
                register
        </Neos.Fusion:Link.Action>
`
```

--------------------------------

### Get character at index

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Retrieves the character at a specific position in a string.

```Eel
String.charAt("abcdefg", 5) == "f"
```

--------------------------------

### Neos.Dimension.currentValue(node, dimensionName)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Get the current dimension value for a specific node.

```APIDOC
## Neos.Dimension.currentValue(node, dimensionName)

### Description
Get the current dimension value for a specific node.

### Parameters
- **node** (Node) - Required - The node to query.
- **dimensionName** (ContentDimensionId|string) - Required - The name of the dimension.

### Return
- (ContentDimensionValue|null) - The current dimension value or null.
```

--------------------------------

### Render a Fusion object with the fusion:render ViewHelper

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Fusion.html

Demonstrates basic usage of the render ViewHelper to output a Fusion path.

```Fusion
Fusion:
some.given {
        path = Neos.Fusion:Template
        …
}
ViewHelper:
<ts:render path="some.given.path" />
```

```text
(the evaluated Fusion, depending on the given path)
```

--------------------------------

### Get current timestamp

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Retrieve the current date and time and access its timestamp property.

```eel
Date.now().timestamp
```

--------------------------------

### List Available Commands

Source: https://neos.readthedocs.io/en/9.1/Operations/CommandLine.html

Lists all available commands, commands within a specific package, or detailed help for a specific command.

```bash
./flow help                     # lists all available command
./flow help <packageKey>        # lists commands provided in package
./flow help <commandIdentifier> # show help for specific command

```

--------------------------------

### Insert elements at the start of an array

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Adds one or more elements to the beginning of the provided array.

```javascript
Array.unshift(array, e1, e2)
```

--------------------------------

### Define a node migration in YAML

Source: https://neos.readthedocs.io/en/9.1/References/NodeMigrations.html

Example configuration for renaming a property on specific node types.

```yaml
comments: 'Rename the property of all Neos.ContentRepository.Testing:Document nodes'
migration:
  -
    filters:
      -
        type: 'NodeType'
        settings:
          nodeType: 'Neos.ContentRepository.Testing:Document'
    transformations:
      -
        type: 'RenameProperty'
        settings:
          from: 'text'
          to: 'newText'
```

--------------------------------

### Create User with Administrative Privileges

Source: https://neos.readthedocs.io/en/9.1/Operations/CommandLine.html

Creates a new user with the specified email, password, name, and assigns administrative roles.

```bash
./flow user:create john@doe.com pazzw0rd John Doe --roles Neos.Neos:Administrator

```

--------------------------------

### Format currency with defaults

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Basic usage of the ViewHelper without additional parameters.

```html
<f:format.currency>123.456</f:format.currency>
```

--------------------------------

### Get current dimension value

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Retrieves the current dimension value for a specific node and dimension name.

```Fusion
Neos.Dimension.currentValue(node, 'language')
```

--------------------------------

### Extract substring with substr

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Returns a portion of a string starting from an offset, following the JavaScript substr specification.

```text
String.substr('Hello, World!', 7, 5) == 'World'
String.substr('Hello, World!', 7) == 'World!'
String.substr('Hello, World!', -6) == 'World!'
```

--------------------------------

### Display available commands

Source: https://neos.readthedocs.io/en/9.1/References/CommandReference.html

Use this command to list all available commands and determine the shortest possible identifiers on your system.

```bash
./flow help
```

--------------------------------

### Linking to Backend Modules with ActionUri

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ReleaseNotes/810.html

Demonstrates using Neos.Fusion:ActionUri to create links to specific backend modules, such as the content module or sites module, by specifying the request context.

```Fusion
cotentModuleUri = Neos.Fusion:ActionUri {
request = ${request.mainRequest}
package =”Neos.Neos.Ui”
controller = “Backend”
action = ‘index’
arguments.node = ${documentNode}
#### }

```

```Fusion
siteModuleUri = Neos.Fusion:ActionUri {
request = ${request.mainRequest}
action = “index”
package = “Neos.Neos”
controller = “Backend\Module”
arguments {
module = ‘administration/sites’
moduleArguments {
@action = ‘edit’
site = ${site}
}
}
#### }

```

--------------------------------

### Documenting a PHP Class

Source: https://neos.readthedocs.io/en/9.1/References/CodingGuideLines/PHP.html

Use a standard DocBlock to provide a short description followed by detailed information, with paragraphs separated by empty lines.

```php
/**
 * First sentence is short description. Then you can write more, just as you like
 *
 * Here may follow some detailed description about what the class is for.
 *
 * Paragraphs are separated by an empty line.
 */
class SomeClass {
 ...
}
```

--------------------------------

### Encode JSON in Fluid

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/FluidAdaptor.html

Examples of using the f:format.json ViewHelper to encode variables and arrays into JSON strings.

```Fluid
{someArray -> f:format.json()}
```

```text
["array","values"]
// depending on the value of {someArray}
```

```Fluid
{f:format.json(value: {foo: 'bar', bar: 'baz'})}
```

```text
{"foo":"bar","bar":"baz"}
```

```Fluid
{f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}
```

```text
{"0":"bar","1":"baz"}
```

--------------------------------

### Documenting PHP Methods

Source: https://neos.readthedocs.io/en/9.1/References/CodingGuideLines/PHP.html

Include descriptions for all parameters and the return value. Parameter types and names should be separated by a single space without a trailing colon.

```php
/**
 * A description for this method
 *
 * Paragraphs are separated by an empty line.
 *
 * @param \Neos\Blog\Domain\Model\Post $post A post
 * @param string $someString This parameter should contain some string
 * @return void
 */
public function addStringToPost(\Neos\Blog\Domain\Model\Post $post, $someString) {
 ...
}
```

--------------------------------

### Reduce an array to a single value

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Accumulates values in an array using a callback function, optionally starting with an initial value.

```javascript
Array.reduce([1, 2, 3, 4], (accumulator, currentValue) => accumulator + currentValue) // == 10
Array.reduce([1, 2, 3, 4], (accumulator, currentValue) => accumulator + currentValue, 1) // == 11
```

--------------------------------

### Retrieve settings using Configuration.setting

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Access application settings by providing a dot-separated path. Returns the value associated with the specified configuration key.

```Eel
Configuration.setting('Neos.Flow.core.context') == 'Production'

Configuration.setting('Acme.Demo.speedMode') == 'light speed'
```

--------------------------------

### Neos.Dimension.originValue(node, dimensionName)

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Get the original dimension value for a node, which may differ from the current value in cases of dimension fallback.

```APIDOC
## Neos.Dimension.originValue(node, dimensionName)

### Description
Get the original dimension value for a node, which may differ from the current value in cases of dimension fallback.

### Parameters
- **node** (Node) - Required - The node to query.
- **dimensionName** (ContentDimensionId|string) - Required - The name of the dimension.

### Return
- (ContentDimensionValue|null) - The original dimension value or null.
```

--------------------------------

### Configure Neos.Neos:Plugin

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Basic configuration for a plugin prototype inheriting from Neos.Neos:Plugin.

```Fusion
prototype(My.Site:Registration) < prototype(Neos.Neos:Plugin) {
        package = 'My.Site'
        controller = 'Registration'
}
```

--------------------------------

### Get original dimension value

Source: https://neos.readthedocs.io/en/9.1/References/EelHelpersReference.html

Retrieves the original dimension value for a node, accounting for cases where dimension fallback might have occurred.

```Fusion
Neos.Dimension.originValue(node, 'language')
```

--------------------------------

### Get type of a value using neos:getType

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Neos.html

Retrieves the type of a given value. Can be used with standard arguments or shorthand syntax.

```Fluid
{neos:getType(value: 'foo')}
```

```Fluid
{myValue -> neos:getType()}
```

--------------------------------

### Execute Manual Subscription Catch-up Command

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/9013.html

Provides a command-line interface to manually trigger a catch-up for the subscription engine. This is useful for recovery scenarios where events might not have been processed due to connection issues or process termination. It ensures that the event store is synchronized with the subscription state.

```php
public function catchUpActiveCommand(string $contentRepository = ‘default’): void {
    
    $subscriptionEngineAccessor = new class implements ContentRepositoryServiceFactoryInterface {
        
        public SubscriptionEngine|null $subscriptionEngine;
        public function build(ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies): ContentRepositoryServiceInterface {
            $this->subscriptionEngine = $serviceFactoryDependencies->subscriptionEngine;
            return new class implements ContentRepositoryServiceInterface { };
        }
    };
    $this->contentRepositoryRegistry->buildService(ContentRepositoryId::fromString($contentRepository), $subscriptionEngineAccessor);
    $subscriptionEngine = $subscriptionEngineAccessor->subscriptionEngine;
    $subscriptionEngine->catchUpActive();
}
```

--------------------------------

### Warm up Fluid caches with variables

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/TYPO3Fluid.html

Use this ViewHelper to assign variables specifically during the cache warmup process.

```html
<f:cache.warmup variables="{foo: bar}">
   Template code depending on {foo} variable which is not
   assigned when warming up Fluid's caches. {foo} is only
   assigned if the variable does not already exist and the
   assignment only happens if Fluid is in warmup mode.
</f:cache.warmup>
```

--------------------------------

### Configure DateTime Property Editor

Source: https://neos.readthedocs.io/en/9.1/References/PropertyEditorReference.html

Example of defining a DateTime property in a node type configuration with a custom date format and default value.

```yaml
publishingDate:
  type: DateTime
  defaultValue: 'today midnight'
  ui:
    label: 'Publishing Date'
    inspector:
      group: 'document'
      position: 10
      editorOptions:
        format: 'd.m.Y'
```

--------------------------------

### Create and switch to a new local branch

Source: https://neos.readthedocs.io/en/9.1/Contribute/Documentation/BeginnersGuide.html

Use this command to initialize a new feature branch from the current master branch.

```bash
git checkout -b [local_branch_name]
```

--------------------------------

### Render Fusion from a foreign package

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Fusion.html

Shows how to specify a package key when rendering Fusion objects located outside the current package.

```HTML
<ts:render path="some.given.path" fusionPackageKey="Acme.Bookstore" />
```

```text
(the evaluated Fusion, depending on the given path)
```

--------------------------------

### Implement Custom Asset Variant Interface

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/840.html

Example of implementing the AssetVariantInterface with a custom class. This is relevant when extending Neos' asset handling capabilities.

```php
final class DummyImageVariant implements AssetVariantInterface {
// …
}
```

--------------------------------

### Define a standard Neos node type

Source: https://neos.readthedocs.io/en/9.1/References/NodeTypeDefinition.html

Example of a node type definition including inspector groups, property configurations, and validation rules.

```yaml
'Neos.NodeTypes:Image':
  superTypes:
    'Neos.Neos:Content': true
  ui:
    label: 'Image'
    icon: 'icon-picture'
    inspector:
      groups:
        image:
          label: 'Image'
          icon: 'icon-image'
          position: 5
  properties:
    image:
      type: Neos\Media\Domain\Model\ImageInterface
      ui:
        label: 'Image'
        reloadIfChanged: true
        inspector:
          group: 'image'
    alignment:
      type: string
      defaultValue: ''
      ui:
        label: 'Alignment'
        reloadIfChanged: true
        inspector:
          group: 'image'
          editor: 'Neos.Neos/Inspector/Editors/SelectBoxEditor'
          editorOptions:
            placeholder: 'Default'
            values:
              '':
                label: ''
              center:
                label: 'Center'
              left:
                label: 'Left'
              right:
                label: 'Right'
    alternativeText:
      type: string
      ui:
        label: 'Alternative text'
        reloadIfChanged: true
        inspector:
          group: 'image'
      validation:
        'Neos.Neos/Validation/StringLengthValidator':
          minimum: 1
          maximum: 255
    hasCaption:
      type: boolean
      ui:
        label: 'Enable caption'
        reloadIfChanged: true
        inspector:
          group: 'image'
    caption:
      type: string
      defaultValue: '<p>Enter caption here</p>'
      ui:
        inlineEditable: true
```

--------------------------------

### Enable Legacy Site Creation Options

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/907.html

Configure Neos to re-enable legacy site import and creation options. This is useful for migrating from older versions or maintaining compatibility.

```yaml
Neos.Neos.modules.administration.submodules.sites.settings.enableLegacyPackageImport: true
Neos.Neos.modules.administration.submodules.sites.settings.enableLegacyPackageCreation: true
```

--------------------------------

### Render Link.Resource in AFX

Source: https://neos.readthedocs.io/en/9.1/References/NeosFusionReference.html

Creates a link pointing to a static resource file.

```fusion
link = afx`
        <Neos.Fusion:Link.Resource class="resource-link" href.path="resource://Some.Package/Public/Images/SomeImage.png">
                Some Link
        </Neos.Fusion:Link.Resource>
`
```

--------------------------------

### neos:backend.configurationTree

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Neos.html

Render HTML markup for the full configuration tree in the Neos Administration -> Configuration Module.

```APIDOC
## neos:backend.configurationTree

### Description
Render HTML markup for the full configuration tree in the Neos Administration -> Configuration Module. For performance reasons, this is done inside a ViewHelper instead of Fluid itself.

### Arguments
- **configuration** (array) - Required - Configuration to show
```

--------------------------------

### Render a Form in Fluid

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Form.html

Use the render ViewHelper to output a form using a custom factory class that implements NeosFormFactoryFormFactoryInterface.

```html
 {namespace form=NeosFormViewHelpers} <form:render factoryClass=”NameOfYourCustomFactoryClass” /> 
```

--------------------------------

### SelectBox Editor Group Labels

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/904.html

Example configuration for a SelectBox editor showing how to define group labels, including i18n values and static text.

```yaml
tagName:
    
type: string defaultValue: ‘h2’ ui:
> label: i18n reloadIfChanged: true inspector:
>> group: settings position: 10 editor: Neos.Neos/Inspector/Editors/SelectBoxEditor editorOptions:
>>> 

values:
     

h1:
    
>>> label: h1 group: i18n 

h2:
    
>>> label: h2 group: i18n 

h3:
    
>>> label: h3 group: ‘Neos.Demo:Main:group.label’ 

h4:
    
>>> label: h4 group: Just some text 

h5:
    
>>> label: h5 group: ‘Neos.Demo:Main:group.label’

```

--------------------------------

### Output unescaped content with f:format.raw

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/TYPO3Fluid.html

Examples showing how to output content without escaping. Use with caution to avoid Cross Site Scripting vulnerabilities.

```html
<f:format.raw>{string}</f:format.raw>
```

```html
<f:format.raw value="{string}" />
```

--------------------------------

### Error messages for active transactions

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ChangeLogs/9012.html

Example error messages encountered when a transaction is active during event commits or lock acquisition. These indicate issues with transaction management.

```text
A transaction is active already, can’t commit events!
```

```text
Failed to acquire checkpoint lock for subscriber “Neos\ContentRepository\Core\Projection\ContentStream\ContentStreamProjection” because a transaction is active
```

--------------------------------

### Create Node Migration CLI Command

Source: https://neos.readthedocs.io/en/9.1/Appendixes/ReleaseNotes/830.html

Use this command to create node migrations via the CLI, specifying a packageKey for the site package.

```bash
node:migrationcreate --packageKey Neos.Demo
```

--------------------------------

### Configure Node link type options

Source: https://neos.readthedocs.io/en/9.1/References/PropertyEditorReference.html

Customizes the node tree behavior for internal links, including starting point, node type filtering, and loading depth.

```yaml
editorOptions:
  # ..
  linking:
    linkTypes:
      Node:
        startingPoint: '/<Neos.Neos:Sites>/my-site/some-feature'
        baseNodeType: 'Vendor.Site:Document'
        loadingDepth: 8
        allowedNodeTypes: ['Vendor.Site:Mixin.ReferenceableDocument']
```

--------------------------------

### Generate and Import RSA Keys

Source: https://neos.readthedocs.io/en/9.1/References/CommandReference.html

Commands for generating, importing, and verifying RSA key pairs for the RSAWalletService.

```bash
ssh-keygen -yf my-key.pem > my-key.pub ssh-keygen -lf my-key.pub
```

```bash
ssh-keygen -t rsa -f my-key ./flow security:importprivatekey < my-key
```

```bash
ssh-keygen -lf my-key.pub
```

--------------------------------

### neos:backend.userInitials

Source: https://neos.readthedocs.io/en/9.1/References/ViewHelpers/Neos.html

Renders user initials for a given username. Note: This ViewHelper is currently a work in progress and not stable.

```APIDOC
## neos:backend.userInitials

### Description
Render user initials for a given username.

### Arguments
- **format** (string) - Optional - Supported are “fullFirstName”, “initials” and “fullName”
```
Tokens:
Raw