PhpStorm 2016.2 Help

Language Injection Settings dialog: XML Tag Injection

File | Settings | Language Injection - XML Tag for Windows and Linux
PhpStorm | Preferences | Language Injection - XML Tag for OS X
Ctrl+Alt+S
settings

The dialog box opens when you click add.png   on the Language Injections page, and choose XML Tag on the context menu, or select an entry and click edit1.

ItemDescription
Name In this text box, type the name that will identify the injection configuration in the list. The text box is available when configuration is created (add), or configured (edit1).
Language In this area, specify the language of the injection. If necessary, define the context to be automatically made up when the injection is opened in the editor.
  • ID - from this drop-down list, select the ID of the language of the injection.
  • Prefix - in this text box, specify the character string to be automatically added before the injection.
  • Suffix - in this text box, specify the character string to be automatically added after the injection.

The Prefix and Suffix text boxes are optional.

XML TagIn this area, define the XML tag which indicates that the text enclosed in this tag should be treated as the selected language.
  • Local name - in this text box, specify the tag name without a namespace prefix. Use regular expressions to specify multiple tag names (name1|name2), case-insensitive names ((?i)tagname matches tagname as well as TagName), etc.
  • Namespace - in this text box, specify the namespace URI of the XML tag.

    The field is optional.

Sub-tagsSelect this check box to include all the subtags recursively.
Advanced In this area, specify additional settings to enable more fine-grained control over the injection process.
  • Value pattern - in this text box, type a regular expression that determines the part of the XML text's value to inject the language into. By using the first capturing group of the pattern as the target for injection, you can configure the procedure to have the language injected only into values that match a certain pattern or into multiple parts that match the pattern.
    Examples:
    [$#]\{(.*?)\} matches the pattern used by the JSP/JSF Expression Language.
    ^javascript:(.*) matches the javascript protocol that can be used in hyperlink-hrefs to execute JavaScript code.
  • XPath condition - in this text box, specify an XPath expression to address the injection-target more precisely. The context in which the expression is evaluated is the surrounding XML tag.

    It is possible to use the XPath extension functions that are provided by the Jaxen XPath engine, e.g. lower-case(). Also, there are three additional functions that can be used to determine the current file's name, extension, and file type: file-name(), file-ext() and file-type(). Alternatively, a list of available functions can be retrieved through standard code completion.

    For the field to be active, the XPathView + XSLT Support plugin must be enabled.

  • Single file - select this check box to specify an exact file to apply the injection to.

See Also

Last modified: 24 November 2016